axlsx 1.0.4 → 1.0.5

data/README.md

@@ -6,8 +6,9 @@ Axlsx: Office Open XML Spreadsheet Generation
 **Author**:       Randy Morgan
 **Copyright**:    2011    
 **License**:      MIT License    
-**Latest Version**: 1.0.2
-**Release Date**: November 20th 2011    
+**Latest Version**: 1.0.5
+**Ruby Version**: 1.8.7
+**Release Date**: November 22nd 2011    
 
 Synopsis
 --------
@@ -40,88 +41,94 @@ To install Axlsx, use the following command:
     
 Usage
 -----
-Simple Workbook
 
-     p = Axlsx::Package.new do |package|
-       package.workbook.add_worksheet do |sheet|
-         sheet.add_row ["First", "Second", "Third"]
-         sheet.add_row [1, 2, 3]
-       end
-       package.serialize("example1.xlsx")
-     end  
-
-Generating A Bar Chart
-	   
-     p = Axlsx::Package.new do |package|
-       package.workbook.add_worksheet do |sheet|
-         sheet.add_row ["First", "Second", "Third"]
-         sheet.add_row [1, 2, 3]
-         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  
+     require 'rubygems'
+     require 'axlsx'
 
-Generating A Pie Chart
+##A Simple Workbook
 
-     p = Axlsx::Package.new do |package|
-       package.workbook.add_worksheet do |sheet|
-         sheet.add_row ["First", "Second", "Third"]
-         sheet.add_row [1, 2, 3]
-         sheet.add_chart(Axlsx::Pie3DChart, :start_at => [0,2], :end_at => [5, 15], :title=>"example 2: Pie Chart") do |chart|
-           chart.add_series :data=>sheet.rows.last.cells, :labels=> sheet.rows.first.cells
-         end
-       end
-       package.serialize("example3.xlsx")
-     end  
+      p = Axlsx::Package.new
+      p.workbook.add_worksheet do |sheet|
+        sheet.add_row ["First", "Second", "Third"]
+        sheet.add_row [1, 2, 3]
+      end
+      p.serialize("example1.xlsx")
 
-Using Custom Styles
+##Generating A Bar Chart
 
-     p = Axlsx::Package.new do |package|
-       style_options = { :bg_color => "FF000000", :fg_color => "FFFFFFFF", :sz=>14, :alignment => { :horizontal=> :center } }
-       header_style = package.workbook.styles.add_style style_options
-       package.workbook.add_worksheet do |sheet|
-         sheet.add_row ["Text Autowidth", "Second", "Third"], :style => header_style
-         sheet.add_row [1, 2, 3], :style => Axlsx::STYLE_THIN_BORDER
+     p = Axlsx::Package.new
+     p.workbook.add_worksheet do |sheet|
+       sheet.add_row ["First", "Second", "Third"]
+       sheet.add_row [1, 2, 3]
+       sheet.add_chart(Axlsx::Bar3DChart, :start_at => [0,2], :end_at => [5, 15], :title=>"example 2: Chart") do |chart|
+         chart.add_series :data=>sheet.rows.last.cells, :labels=> sheet.rows.first.cells
        end
-       package.serialize("example3.xlsx")
      end  
+     p.serialize("example2.xlsx")
 
-Cell Specifc Styles
-
-     p = Axlsx::Package.new do |package|
+##Generating A Pie Chart
 
-       black_cell_spec = { :bg_color => "FF000000", :fg_color => "FFFFFFFF", :sz=>14, :alignment => { :horizontal=> :center } }
-       blue_cell_spec = { :bg_color => "FF0000FF", :fg_color => "FFFFFFFF", :sz=>14, :alignment => { :horizontal=> :center } }
-
-       black_cell = package.workbook.styles.add_style black_cell_spec
-       blue_cell = package.workbook.styles.add_style blue_cell_spec
-
-       # date1904 support. uncomment the line below if you are working on a mac.
-       # package.workbook.date1904 = true 
-
-       package.workbook.add_worksheet do |sheet|
-         sheet.add_row ["Text Autowidth", "Second", "Third"], :style => [black_cell, blue_cell, black_cell]
-         sheet.add_row [1, 2, 3], :style => Axlsx::STYLE_THIN_BORDER
+     p = Axlsx::Package.new
+     p.workbook.add_worksheet do |sheet|
+       sheet.add_row ["First", "Second", "Third"]
+       sheet.add_row [1, 2, 3]
+       sheet.add_chart(Axlsx::Pie3DChart, :start_at => [0,2], :end_at => [5, 15], :title=>"example 3: Pie Chart") do |chart|
+         chart.add_series :data=>sheet.rows.last.cells, :labels=> sheet.rows.first.cells
        end
-       package.serialize("example3.xlsx")
      end  
-
-Number and Date formatting
-
-     p = Axlsx::Package.new do |package|
-       date = package.workbook.styles.add_style :format_code=>"yyyy-mm-dd", :border => Axlsx::STYLE_THIN_BORDER
-       padded = package.workbook.styles.add_style :format_code=>"00#", :border => Axlsx::STYLE_THIN_BORDER
-       percent = package.workbook.styles.add_style :format_code=>"0%", :border => Axlsx::STYLE_THIN_BORDER
-
-       package.workbook.add_worksheet do |sheet|
-         sheet.add_row
-         sheet.add_row ["Custom Formatted Date", "Percent Formatted Float", "Padded Numbers"], :style => Axlsx::STYLE_THIN_BORDER
-         sheet.add_row [Time.now, 0.2, 32], :style => [date, percent, padded]
+     p.serialize("example3.xlsx")
+
+##Using Custom Styles
+
+     p = Axlsx::Package.new
+     wb = p.workbook
+     black_cell = wb.styles.add_style :bg_color => "FF000000", :fg_color => "FFFFFFFF", :sz=>14, :alignment => { :horizontal=> :center }
+     blue_cell = wb.styles.add_style  :bg_color => "FF0000FF", :fg_color => "FFFFFFFF", :sz=>14, :alignment => { :horizontal=> :center }
+     wb.add_worksheet do |sheet|
+       sheet.add_row ["Text Autowidth", "Second", "Third"], :style => [black_cell, blue_cell, black_cell]
+       sheet.add_row [1, 2, 3], :style => Axlsx::STYLE_THIN_BORDER
+     end
+     p.serialize("example4.xlsx")
+
+##Using Custom Formatting and date1904
+
+     p = Axlsx::Package.new
+     wb = p.workbook
+     date = wb.styles.add_style :format_code=>"yyyy-mm-dd", :border => Axlsx::STYLE_THIN_BORDER
+     padded = wb.styles.add_style :format_code=>"00#", :border => Axlsx::STYLE_THIN_BORDER
+     percent = wb.styles.add_style :format_code=>"0%", :border => Axlsx::STYLE_THIN_BORDER
+     wb.date1904 = true # required for generation on mac
+     wb.add_worksheet do |sheet|
+       sheet.add_row ["Custom Formatted Date", "Percent Formatted Float", "Padded Numbers"], :style => Axlsx::STYLE_THIN_BORDER
+       sheet.add_row [Time.now, 0.2, 32], :style => [date, percent, padded]
+     end
+     p.serialize("example5.xlsx")
+
+##Validation
+
+     p = Axlsx::Package.new
+     p.workbook.add_worksheet do |sheet|
+       sheet.add_row ["First", "Second", "Third"]
+       sheet.add_row [1, 2, 3]
+     end
+
+     p.validate.each do |error|
+       puts error.inspect
+     end
+
+#Generating A Line Chart
+
+     p = Axlsx::Package.new
+     p.workbook.add_worksheet do |sheet|
+       sheet.add_row ["First", 1, 5, 7, 9]
+       sheet.add_row ["Second", 5, 2, 14, 9]
+       sheet.add_chart(Axlsx::Line3DChart, :start_at => [0,2], :end_at => [10, 15], :title=>"example 6: Line Chart") do |chart|
+         chart.add_series :data=>sheet.rows.first.cells[(1..-1)], :title=> sheet.rows.first.cells.first
+         chart.add_series :data=>sheet.rows.last.cells[(1..-1)], :title=> sheet.rows.last.cells.first
        end
-       package.serialize("example5.xlsx")
      end  
+     p.serialize("example6.xlsx")
+
 
 ### 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:
@@ -130,7 +137,7 @@ This gem is 100% documented with YARD, an exceptional documentation library. To
 
 
 ### Specs
-This gem has 100% test coverage. To execute tests for this gem, simply run rake in the gem directory.
+This gem has 100% test coverage using test/unit. To execute tests for this gem, simply run rake in the gem directory.
  
 Changelog
 ---------
@@ -138,8 +145,24 @@ Changelog
 - **October.20.11**: 0.1.0 release
 - **October.21.11**: 1.0.3 release
   - Updated documentation
+- **October.21.11**: 1.0.4
   - altered package to accept a filename string for serialization instead of a File object.
   - Updated specs to conform
+  - More examples for readme
+- **October.22.11**: 1.05  
+  - Added support for line charts
+  - Updated examples and readme
+  - Updated series title to be a real title ** NOTE ** If you are accessing titles directly you will need to update text assignation to title.text = v
+  - BugFix: shape attribute for bar chart is now properly serialized
+  - BugFix: date1904 property now properly set for charts
+  - Added style property to charts
+  - Removed serialization write test as it most commonly fails when run from the gem's intalled directory
+
+On Deck
+-------
+
+- Verification with ruby 1.9.3
+- Active Record support via package::serialize_ar so you can dump an AR result into a worksheet in one go.
 
 Copyright
 ---------

data/examples/example.rb

@@ -0,0 +1,83 @@
+     require 'rubygems'
+     require 'axlsx'
+
+#A Simple Workbook
+      p = Axlsx::Package.new
+      p.workbook.add_worksheet do |sheet|
+        sheet.add_row ["First", "Second", "Third"]
+        sheet.add_row [1, 2, 3]
+      end
+      p.serialize("example1.xlsx")
+
+#Generating A Bar Chart
+     p = Axlsx::Package.new
+     p.workbook.add_worksheet do |sheet|
+       sheet.add_row ["First", "Second", "Third"]
+       sheet.add_row [1, 2, 3]
+       sheet.add_chart(Axlsx::Bar3DChart, :start_at => [0,2], :end_at => [5, 15], :title=>"example 2: Chart") do |chart|
+         chart.add_series :data=>sheet.rows.last.cells, :labels=> sheet.rows.first.cells
+       end
+     end  
+     p.serialize("example2.xlsx")
+
+#Generating A Pie Chart
+     p = Axlsx::Package.new
+     p.workbook.add_worksheet do |sheet|
+       sheet.add_row ["First", "Second", "Third"]
+       sheet.add_row [1, 2, 3]
+       sheet.add_chart(Axlsx::Pie3DChart, :start_at => [0,2], :end_at => [5, 15], :title=>"example 3: Pie Chart") do |chart|
+         chart.add_series :data=>sheet.rows.last.cells, :labels=> sheet.rows.first.cells
+       end
+     end  
+     p.serialize("example3.xlsx")
+
+
+#Using Custom Styles
+
+     p = Axlsx::Package.new
+     wb = p.workbook
+     black_cell = wb.styles.add_style :bg_color => "FF000000", :fg_color => "FFFFFFFF", :sz=>14, :alignment => { :horizontal=> :center }
+     blue_cell = wb.styles.add_style  :bg_color => "FF0000FF", :fg_color => "FFFFFFFF", :sz=>14, :alignment => { :horizontal=> :center }
+     wb.add_worksheet do |sheet|
+       sheet.add_row ["Text Autowidth", "Second", "Third"], :style => [black_cell, blue_cell, black_cell]
+       sheet.add_row [1, 2, 3], :style => Axlsx::STYLE_THIN_BORDER
+     end
+     p.serialize("example4.xlsx")
+
+#Using Custom Formatting and date1904
+
+     p = Axlsx::Package.new
+     wb = p.workbook
+     date = wb.styles.add_style :format_code=>"yyyy-mm-dd", :border => Axlsx::STYLE_THIN_BORDER
+     padded = wb.styles.add_style :format_code=>"00#", :border => Axlsx::STYLE_THIN_BORDER
+     percent = wb.styles.add_style :format_code=>"0%", :border => Axlsx::STYLE_THIN_BORDER
+     wb.date1904 = true # required for generation on mac
+     wb.add_worksheet do |sheet|
+       sheet.add_row ["Custom Formatted Date", "Percent Formatted Float", "Padded Numbers"], :style => Axlsx::STYLE_THIN_BORDER
+       sheet.add_row [Time.now, 0.2, 32], :style => [date, percent, padded]
+     end
+     p.serialize("example5.xlsx")
+
+#Validation
+     p = Axlsx::Package.new
+     p.workbook.add_worksheet do |sheet|
+       sheet.add_row ["First", "Second", "Third"]
+       sheet.add_row [1, 2, 3]
+     end
+
+     p.validate.each do |error|
+       puts error.inspect
+     end
+      
+#Generating A Line Chart
+
+     p = Axlsx::Package.new
+     p.workbook.add_worksheet do |sheet|
+       sheet.add_row ["First", 1, 5, 7, 9]
+       sheet.add_row ["Second", 5, 2, 14, 9]
+       sheet.add_chart(Axlsx::Line3DChart, :start_at => [0,2], :end_at => [10, 15], :title=>"example 6: Line Chart") do |chart|
+         chart.add_series :data=>sheet.rows.first.cells[(1..-1)], :title=> sheet.rows.first.cells.first
+         chart.add_series :data=>sheet.rows.last.cells[(1..-1)], :title=> sheet.rows.last.cells.first
+       end
+     end  
+     p.serialize("example6.xlsx")

data/examples/example.rb~

@@ -0,0 +1,79 @@
+require 'rubygems'
+require 'axlsx'
+
+wb =Axlsx::Workbook.new(:date1904=>true)
+p = Axlsx::Package.new(:workbook=>wb)
+
+styles = wb.styles
+
+header_style = styles.add_style(:bg_color=>"FF000000", :fg_color=>"FFFFFFFF", :sz=>14, :alignment=>{:horizontal=>:center})
+table_title = styles.add_style :sz=>22
+date_time = styles.add_style(:num_fmt=>Axlsx::NUM_FMT_YYYYMMDDHHMMSS)
+date = styles.add_style :num_fmt=>Axlsx::NUM_FMT_YYYYMMDD
+bordered = styles.add_style :border=>Axlsx::STYLE_THIN_BORDER
+
+wb.add_worksheet do |sheet|
+  sheet.name = "Example 1"
+  # add cells as a row
+  sheet.add_row :values=>['Example 1 Styling and Bar Chart'], :style=>table_title
+  sheet.add_row :values=>["Formatted Time Stamp", Time.now],:style=>[nil, date_time]
+  # adding cells one at a time
+  sheet.add_row do |row|
+    row.add_cell "Formatted Date" 
+    row.add_cell Time.now, :style => date, :type=>:time
+  end
+
+  # Bar 3D Chart
+  sheet.add_row
+  label_row = sheet.add_row :values=>["0 ~ 10", "11 ~ 20", "21 ~ 60"], :style=>header_style
+  data_row = sheet.add_row :values=>[12, 60, 25], :style=>bordered
+  sheet.add_chart(Axlsx::Bar3DChart, :show_legend=>false) do |chart|
+    chart.title = Axlsx::Title.new(sheet.rows.first.cells.first)
+    chart.add_series :data => data_row.cells, :labels => label_row.cells
+    chart.start_at.coord(0, 7)
+    chart.end_at.coord(3, 17)
+  end
+
+end
+
+# Blocks are not required
+percent = styles.add_style :num_fmt=>Axlsx::NUM_FMT_PERCENT, :border=>Axlsx::STYLE_THIN_BORDER
+wb.add_worksheet(:name=>"Example 2") do |sheet|
+  sheet.add_row :values=>["Example 2 - Styling and Pie Chart"], :style=>table_title
+  label_row = sheet.add_row(:values=>["Summer", "Fall", "Winter", "Spring"], :style=>header_style)
+  data_row =  sheet.add_row :values=>[0.5, 0.2, 0.2, 0.1], :style=>percent
+  chart = sheet.add_chart(Axlsx::Pie3DChart, :start_at => [0,4], :end_at => [4,14], :title => "Pie Consumption per Season") do |chart|
+    chart.add_series  :data => data_row.cells, :labels=>label_row.cells
+  end
+end
+# Charts can be build with out data in the sheet
+wb.add_worksheet(:name=>"Example 3") do |ws|
+  ws.add_row :values=>["Charts can be build without any data in the worksheet"]
+  ws.add_chart(Axlsx::Pie3DChart, :title=>"free chart 1") do |chart|
+    chart.start_at.coord(0,2)
+    chart.end_at.coord(3,12)
+    chart.add_series :data => [13,54,1], :labels=>["nothing","in","the sheet"]
+  end
+  ws.add_chart(Axlsx::Pie3DChart) do |chart|
+    chart.start_at.coord(0,13)
+    chart.end_at.coord(3,23)
+    chart.add_series :data => [1,4,5], :labels=>["nothing","in","the sheet"], :title=>"free chart 2"
+  end
+end
+
+# wb.add_worksheet(:name=>"Example 4") do |sheet|
+#   sheet.add_row :values=>["lots of data!"]  
+#   (1..100).each do |i|
+#     cells = (1..50).map { |i| rand(5 ** 10) }
+#     sheet.add_row :values=>cells
+#   end
+# end
+
+errors = p.validate
+if errors.empty?
+  f = File.open('test.xlsx', 'w')
+  p.serialize(f)
+else
+  puts errors.to_s
+end
+

data/lib/axlsx/drawing/bar_3D_chart.rb

@@ -77,8 +77,6 @@ module Axlsx
     # @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)
@@ -86,6 +84,8 @@ module Axlsx
       @catAxis = CatAxis.new(@catAxId, @valAxId)
       @valAxis = ValAxis.new(@valAxId, @catAxId)
       @view3D = View3D.new(:rAngAx=>1)
+      super(frame, options)      
+      @series_type = BarSeries
     end
     
     def barDir=(v) 

data/lib/axlsx/drawing/bar_series.rb

@@ -73,6 +73,7 @@ module Axlsx
             }                        
           }
         }
+        xml.send('c:shape', :val=>@shape)
       end      
     end
 

data/lib/axlsx/drawing/chart.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 module Axlsx
   # A Chart is the superclass for specific charts
   # @note Worksheet#add_chart is the recommended way to create charts for your worksheets.
@@ -7,6 +8,11 @@ module Axlsx
     # @return [Title]
     attr_accessor :title
 
+    # The style for the chart. 
+    # see ECMA Part 1 §21.2.2.196
+    # @return [Integer]
+    attr_accessor :style
+
     # The 3D view properties for the chart
     attr_accessor :view3D
 
@@ -50,6 +56,7 @@ module Axlsx
     # @option options [Cell, String] title
     # @option options [Boolean] show_legend
     def initialize(frame, options={})
+      @style = 2
       @graphic_frame=frame
       @graphic_frame.anchor.drawing.worksheet.workbook.charts << self
       @series = SimpleTypedList.new Series
@@ -79,6 +86,8 @@ module Axlsx
 
     def show_legend=(v) Axlsx::validate_boolean(v); @show_legend = v; end
 
+    def style=(v) DataTypeValidator.validate "Chart.style", Integer, v, lambda { |v| v >= 1 && v <= 48 }; @style = v; end
+
     # Adds a new series to the chart's series collection.
     # @return [Series]
     # @see Series
@@ -92,6 +101,8 @@ module Axlsx
     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:date1904', :val=>Axlsx::Workbook.date1904)
+          xml.send('c:style', :val=>style)
           xml.send('c:chart') {
             @title.to_xml(xml) unless @title.nil?
             @view3D.to_xml(xml) unless @view3D.nil?

data/lib/axlsx/drawing/drawing.rb

@@ -1,14 +1,17 @@
 module Axlsx
+  require 'axlsx/drawing/title.rb'
+  require 'axlsx/drawing/series_title.rb'
   require 'axlsx/drawing/series.rb'
   require 'axlsx/drawing/pie_series.rb'
   require 'axlsx/drawing/bar_series.rb'  
+  require 'axlsx/drawing/line_series.rb'  
 
   require 'axlsx/drawing/axis.rb'
+  require 'axlsx/drawing/ser_axis.rb'
   require 'axlsx/drawing/cat_axis.rb'
   require 'axlsx/drawing/val_axis.rb'
   require 'axlsx/drawing/view_3D.rb'
   require 'axlsx/drawing/scaling.rb'
-  require 'axlsx/drawing/title.rb'
 
   require 'axlsx/drawing/graphic_frame.rb'
   require 'axlsx/drawing/marker.rb'
@@ -17,6 +20,7 @@ module Axlsx
   require 'axlsx/drawing/chart.rb'
   require 'axlsx/drawing/pie_3D_chart.rb'
   require 'axlsx/drawing/bar_3D_chart.rb'
+  require 'axlsx/drawing/line_3D_chart.rb'
 
   # A Drawing is a canvas for charts. Each worksheet has a single drawing that can specify multiple anchors which reference charts.
   # @note The recommended way to manage drawings is to use the Worksheet.add_chart method, specifying the chart class, start and end marker locations.