axlsx 1.0.18 → 1.1.0

data/examples/example.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby -w -s
 # -*- coding: utf-8 -*-
-require 'axlsx.rb'
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
 
 p = Axlsx::Package.new
 wb = p.workbook
@@ -23,6 +24,19 @@ wb.styles do |s|
   end
 end
 
+#Using Custom Border Styles
+
+wb.styles do |s|
+  red_border =  s.add_style :border => {:style=>:thin, :color =>"FFFF0000"}
+  blue_border =  s.add_style :border => {:style=>:thin, :color =>"FF0000FF"}
+
+  wb.add_worksheet(:name => "Custom Borders") do |sheet|
+    sheet.add_row ["wrap", "me", "Up in Red"], :style => red_border
+    sheet.add_row [1, 2, 3], :style => blue_border
+  end
+end
+
+
 ##Using Custom Formatting and date1904
 require 'date'
 wb.styles do |s|
@@ -36,10 +50,11 @@ wb.styles do |s|
   end
 end
 
+
 ##Add an Image
 
 wb.add_worksheet(:name => "Images") do |sheet|
-  img = File.expand_path('examples/image1.jpeg')
+  img = File.expand_path('../image1.jpeg', __FILE__)
   sheet.add_image(:image_src => img, :noSelect => true, :noMove => true) do |image|
     image.width=720
     image.height=666
@@ -50,7 +65,7 @@ end
 ##Add an Image with a hyperlink
 
 wb.add_worksheet(:name => "Image with Hyperlink") do |sheet|
-  img = File.expand_path('examples/image1.jpeg')
+  img = File.expand_path('../image1.jpeg', __FILE__)
   sheet.add_image(:image_src => img, :noSelect => true, :noMove => true, :hyperlink=>"http://axlsx.blogspot.com") do |image|
     image.width=720
     image.height=666
@@ -80,6 +95,20 @@ wb.styles do |s|
   end
 end
 
+##Hiding Columns
+
+wb.styles do |s|
+  percent = s.add_style :num_fmt => 9
+  wb.add_worksheet(:name => "Hidden Column") do |sheet|
+    sheet.add_row ['col 1', 'col 2', 'col 3', 'col 4']
+    sheet.add_row [1, 2, 0.3, 4]
+    sheet.add_row [1, 2, 0.2, 4]
+    sheet.add_row [1, 2, 0.1, 4]
+    sheet.col_style 2, percent, :row_offset => 1
+    sheet.column_info[1].hidden = true
+  end
+end
+
 ##Styling Rows
 
 wb.styles do |s|
@@ -144,6 +173,18 @@ wb.add_worksheet(:name => "Bar Chart") do |sheet|
   end
 end
 
+##Hide Gridlines in chart
+wb.add_worksheet(:name => "Chart With No Gridlines") do |sheet|
+  sheet.add_row ["A Simple Bar Chart"]
+  sheet.add_row ["First", "Second", "Third"]
+  sheet.add_row [1, 2, 3]
+  sheet.add_chart(Axlsx::Bar3DChart, :start_at => "A4", :end_at => "F17") do |chart|
+    chart.add_series :data => sheet["A3:C3"], :labels => sheet["A2:C2"], :title => sheet["A1"]
+    chart.valAxis.gridlines = false
+    chart.catAxis.gridlines = false
+  end
+end
+
 ##Generating A Pie Chart
 
 wb.add_worksheet(:name => "Pie Chart") do |sheet|
@@ -183,6 +224,21 @@ wb.add_worksheet(:name => "Line Chart") do |sheet|
   end
 end
 
+##Generating A Scatter Chart
+
+wb.add_worksheet(:name => "Scatter Chart") do |sheet|
+  sheet.add_row ["First",  1,  5,  7,  9]
+  sheet.add_row ["",       1, 25, 49, 81]
+  sheet.add_row ["Second", 5,  2, 14,  9]
+  sheet.add_row ["",       5, 10, 15, 20]
+  sheet.add_chart(Axlsx::ScatterChart, :title => "example 7: Scatter Chart") do |chart|
+    chart.start_at 0, 4
+    chart.end_at 10, 19
+    chart.add_series :xData => sheet["B1:E1"], :yData => sheet["B2:E2"], :title => sheet["A1"]
+    chart.add_series :xData => sheet["B3:E3"], :yData => sheet["B4:E4"], :title => sheet["A3"]
+  end
+end
+
 ##Auto Filter
 
 wb.add_worksheet(:name => "Auto Filter") do |sheet|
@@ -194,11 +250,38 @@ wb.add_worksheet(:name => "Auto Filter") do |sheet|
   sheet.auto_filter = "A2:D5"
 end
 
+##Tables
+
+ wb.add_worksheet(:name => "Table") do |sheet|
+   sheet.add_row ["Build Matrix"]
+   sheet.add_row ["Build", "Duration", "Finished", "Rvm"]
+   sheet.add_row ["19.1", "1 min 32 sec", "about 10 hours ago", "1.8.7"]
+   sheet.add_row ["19.2", "1 min 28 sec", "about 10 hours ago", "1.9.2"]
+   sheet.add_row ["19.3", "1 min 35 sec", "about 10 hours ago", "1.9.3"]
+   sheet.add_table "A2:D5", :name => 'Build Matrix'
+ end
+
+
 ##Specifying Column Widths
 
 wb.add_worksheet(:name => "custom column widths") do |sheet|
   sheet.add_row ["I use autowidth and am very wide", "I use a custom width and am narrow"]
-  sheet.column_widths nil, 3
+  sheet.add_row ['abcdefg', 'This is a very long text and should flow into the right cell', nil, 'xxx' ]
+  sheet.column_widths nil, 3, 5, nil
+end
+
+##Fit to page printing
+
+wb.add_worksheet(:name => "fit to page") do |sheet|
+  sheet.add_row ['this all goes on one page']
+  sheet.fit_to_page = true
+end
+
+
+##Hide Gridlines in worksheet
+wb.add_worksheet(:name => "No Gridlines") do |sheet|
+  sheet.add_row ["This", "Sheet", "Hides", "Gridlines"]
+  sheet.show_gridlines = false
 end
 
 ##Specify Page Margins for printing
@@ -209,7 +292,7 @@ end
 
 ##Validate and Serialize
 
-p.validate.each { |e| puts e.message }
+#p.validate.each { |e| puts e.message }
 p.serialize("example.xlsx")
 
 s = p.to_stream()
@@ -221,6 +304,15 @@ p.use_shared_strings = true
 p.serialize("shared_strings_example.xlsx")
 
 
+##Disabling Autowidth
+p = Axlsx::Package.new
+p.use_autowidth = false
+wb = p.workbook
+wb.add_worksheet(:name => "No Magick") do | sheet |
+  sheet.add_row ['oh look! no autowidth - and no magick loaded in your process']
+end
+p.validate.each { |e| puts e.message }
+p.serialize("no-use_autowidth.xlsx")
 
 
 

data/lib/axlsx.rb

@@ -5,6 +5,9 @@ require 'axlsx/util/simple_typed_list.rb'
 require 'axlsx/util/constants.rb'
 require 'axlsx/util/validators.rb'
 require 'axlsx/util/storage.rb'
+
+#not even close to being ready but it does not break anything so it stays for now.
+# needs a full re-write to use agile-encryption properly
 require 'axlsx/util/cbf.rb'
 require 'axlsx/util/ms_off_crypto.rb'
 
@@ -22,10 +25,8 @@ require 'axlsx/rels/relationships.rb'
 require 'axlsx/drawing/drawing.rb'
 require 'axlsx/workbook/workbook.rb'
 require 'axlsx/package.rb'
-
 #required gems
 require 'nokogiri'
-require 'RMagick'
 require 'zip/zip'
 
 #core dependencies
@@ -33,8 +34,8 @@ require 'bigdecimal'
 require 'time'
 
 #if object does not have this already, I am borrowing it from active_support.
-# I am a very big fan of activesupports instance_values method, but do not want to require nor include the entire 
-# library just for this one method. 
+# I am a very big fan of activesupports instance_values method, but do not want to require nor include the entire
+# library just for this one method.
 if !Object.respond_to?(:instance_values)
   Object.send :public  # patch for 1.8.7 as it uses private scope
   Object.send :define_method, :instance_values do
@@ -42,12 +43,11 @@ if !Object.respond_to?(:instance_values)
   end
 end
 
-
 # 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          
+    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
@@ -56,11 +56,32 @@ module Axlsx
 
   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  |val, c|        
-      val[:i] += ((c.bytes.first - 65) + val[:base]); val[:base] *= 26; val 
+    v = name[/[A-Z]+/].reverse.chars.reduce({:base=>1, :i=>0}) do  |val, c|
+      val[:i] += ((c.bytes.first - 64) * val[:base]); val[:base] *= 26; val
     end
 
-    [v[:i]-1, ((name[/[1-9]+/]).to_i)-1]
+    [v[:i]-1, ((name[/[1-9][0-9]*/]).to_i)-1]
 
   end
+
+  # converts the column index into alphabetical values.
+  # @note This follows the standard spreadsheet convention of naming columns A to Z, followed by AA to AZ etc.
+  # @return [String]
+  def self.col_ref(index)
+    chars = []
+    while index >= 26 do
+      chars << ((index % 26) + 65).chr
+      index = index / 26 - 1
+    end
+    chars << (index + 65).chr
+    chars.reverse.join
+  end
+
+  # @return [String] The alpha(column)numeric(row) reference for this sell.
+  # @example Relative Cell Reference
+  #   ws.rows.first.cells.first.r #=> "A1"
+  def self.cell_r(c_index, r_index)
+    Axlsx::col_ref(c_index).to_s << (r_index+1).to_s
+  end
+
 end

data/lib/axlsx/content_type/content_type.rb

@@ -10,15 +10,15 @@ module Axlsx
       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(:save_with => 0)
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<?xml version="1.0" encoding="UTF-8"?>'
+      str << '<Types xmlns="' << XML_NS_T << '">'
+      each { |type| type.to_xml_string(str) }
+      str << '</Types>'
     end
+
   end
 end

data/lib/axlsx/content_type/default.rb

@@ -8,7 +8,7 @@ module Axlsx
     attr_reader :Extension
 
     # The type of content.
-    # @return [String] 
+    # @return [String]
     attr_reader :ContentType
 
     #Creates a new Default object
@@ -19,7 +19,7 @@ module Axlsx
       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
     end
     # Sets the file extension for this content type.
     def Extension=(v) Axlsx::validate_string v; @Extension = v end
@@ -28,11 +28,14 @@ module Axlsx
     # @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.
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml(xml)
-      xml.Default(self.instance_values)
+    def to_xml_string(str = '')
+      str << '<Default '
+      str << instance_values.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      str << '/>'
     end
+
   end
 end

data/lib/axlsx/content_type/override.rb

@@ -4,11 +4,11 @@ module Axlsx
   class Override
 
     # The type of content.
-    # @return [String] 
+    # @return [String]
     attr_reader :ContentType
 
     # The name and location of the part.
-    # @return [String] 
+    # @return [String]
     attr_reader :PartName
 
     #Creates a new Override object
@@ -19,20 +19,24 @@ module Axlsx
       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
     end
 
     # The name and location of the part.
     def PartName=(v) Axlsx::validate_string v; @PartName = v end
 
-    # The content type. 
+    # 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)
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<Override '
+      str << instance_values.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      str << '/>'
     end
+
   end
 end

data/lib/axlsx/doc_props/app.rb

@@ -17,7 +17,7 @@ module Axlsx
     attr_reader :Manager
 
     # @return [String] The name of the company generating the document.
-    attr_reader :Company 
+    attr_reader :Company
 
     # @return [Integer] The number of pages in the document.
     attr_reader :Pages
@@ -43,7 +43,7 @@ module Axlsx
     # @return [Integer] The number of slides that have notes.
     attr_reader :Notes
 
-    # @return [Integer] The total amount of time spent editing.   
+    # @return [Integer] The total amount of time spent editing.
     attr_reader :TotalTime
 
     # @return [Integer] The number of hidden slides.
@@ -60,11 +60,11 @@ module Axlsx
 
     # @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. 
+    # @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.
@@ -96,7 +96,7 @@ module Axlsx
     # @option options [Boolean] ScaleCrop
     # @option options [Boolean] LinksUpToDate
     # @option options [Integer] CharactersWithSpaces
-    # @option options [Boolean] ShareDoc    
+    # @option options [Boolean] ShareDoc
     # @option options [String] HyperLinkBase
     # @option options [String] HyperlinksChanged
     # @option options [String] Application
@@ -109,70 +109,67 @@ module Axlsx
     end
 
     # Sets the Template property of your app.xml file
-    def Template=(v) Axlsx::validate_string v; @Template = v; end 
+    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 
+    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 
+    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 
+    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 
+    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 
+    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 
+    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 
+    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 
+    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 
+    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 
+    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 
+    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 
+    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 
+    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 
+    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 
+    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 
+    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 
+    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 
+    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 
+    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 
+    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 
+    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(:save_with => 0)
+    def DocSecurity=(v) Axlsx::validate_int v; @DocSecurity = v; end
+
+    # 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 << '</Properties>'
     end
+
   end
 end