axlsx 1.1.0 → 1.2.0

data/Rakefile

@@ -4,21 +4,33 @@ task :build => :gendoc do
   system "gem build axlsx.gemspec"
 end
 
-task :gendoc do   
-  system "yardoc"
+task :benchmark do
+  require File.expand_path(File.dirname(__FILE__) + '/test/benchmark.rb')
 end
 
-task :test do 
+task :gendoc do
+  #puts 'yard doc generation disabled until JRuby build native extensions for redcarpet or yard removes the dependency.'
+    system "yardoc"
+    system "yard stats --list-undoc"
+end
+
+task :test do
      require 'rake/testtask'
      Rake::TestTask.new do |t|
        t.libs << 'test'
        t.test_files = FileList['test/**/tc_*.rb']
-       t.verbose = true
+       t.verbose = false
+       t.warning = true
      end
 end
 
+task :report do
+  require 'cover_me'
+  CoverMe.complete!
+end
+
 task :release => :build do
   system "gem push axlsx-#{Axlsx::VERSION}.gem"
 end
 
-task :default => :test
+task :default => :test

data/examples/basic_charts.rb

@@ -0,0 +1,54 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+p = Axlsx::Package.new
+wb = p.workbook
+
+# Pie Chart
+wb.add_worksheet(:name => "Pie Chart") do |sheet|
+  sheet.add_row ["First", "Second", "Third", "Fourth"]
+  sheet.add_row [1, 2, 3, 4]
+  sheet.add_chart(Axlsx::Pie3DChart, :start_at => [0,2], :end_at => [5, 15], :title=> 'dark corner here') do |chart|
+    chart.add_series :data => sheet["A2:D2"], :labels => sheet["A1:D1"]
+    chart.d_lbls.show_val = true
+    chart.d_lbls.show_percent = true
+    chart.d_lbls.d_lbl_pos = :outEnd
+    chart.d_lbls.show_leader_lines = true
+  end
+end
+
+# line chart
+ wb.add_worksheet(:name => "Line Chart") do |sheet|
+  sheet.add_row ['1', '2', '3', '4']
+  sheet.add_row [1, 2, 3, '=sum(A2:C2)']
+  sheet.add_chart(Axlsx::Line3DChart, :start_at => [0,2], :end_at => [5, 15], :title => "Chart") do |chart|
+    chart.add_series :data => sheet["A2:D2"], :labels => sheet["A1:D1"], :title => 'bob'
+    chart.d_lbls.show_val = true
+    chart.d_lbls.show_cat_name = true
+  end
+ end
+
+# bar chart
+ wb.add_worksheet(:name => "Bar Chart") 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.label_rotation = -45
+    chart.catAxis.label_rotation = 45
+    chart.d_lbls.d_lbl_pos = :outEnd
+    chart.d_lbls.show_val = true
+  end
+ end
+
+# specifying colors and title
+wb.add_worksheet(:name => "Colored Pie Chart") do |sheet|
+  sheet.add_row ["First", "Second", "Third", "Fourth"]
+  sheet.add_row [1, 2, 3, "=PRODUCT(A2:C2)"]
+  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["A2:D2"], :labels => ["A1:D1"], :colors => ['FF0000', '00FF00', '0000FF']
+  end
+end
+
+p.serialize('basic_charts.xlsx')
+

data/examples/chart_colors.rb

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+
+p = Axlsx::Package.new
+wb = p.workbook
+
+##Generating A Bar Chart
+
+wb.add_worksheet(:name => "Bar Chart") do |sheet|
+  sheet.add_row ["A Simple Bar Chart"]
+  sheet.add_row ["First", "Second", "Third"]
+  sheet.add_row [1,2,3.5]
+  sheet.add_chart(Axlsx::Bar3DChart, :start_at => "A4", :end_at => "F17", :title => sheet["A1"]) do |chart|
+    chart.add_series :data => sheet["A3:C3"], :labels => sheet["A2:C2"], :colors => ['FF0000', '00FF00', '0000FF'], :color => "000000"
+    chart.valAxis.label_rotation = -45
+    chart.catAxis.label_rotation = 45
+  end
+end
+
+##Generating A Bar Chart without data in the sheet
+
+wb.add_worksheet(:name => "Hard Bar Chart") do |sheet|
+  sheet.add_chart(Axlsx::Bar3DChart, :start_at => "A4", :end_at => "F17", :title => "hard code chart") do |chart|
+    chart.add_series :data => [1,3,5], :labels => ['a', 'b', 'c'], :colors => ['FF0000', '00FF00', '0000FF']
+    chart.valAxis.label_rotation = -45
+    chart.catAxis.label_rotation = 45
+  end
+end
+
+
+##Generating A Pie Chart
+
+ wb.add_worksheet(:name => "Pie Chart") do |sheet|
+   sheet.add_row ["First", "Second", "Third", "Fourth"]
+   sheet.add_row [1, 2, 3, "=PRODUCT(A2:C2)"]
+  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["A2:D2"], :labels => sheet["A1:D1"], :colors => ['FF0000', '00FF00', '0000FF', '000000']
+   end
+ end
+
+# Line Chart
+
+wb.add_worksheet(:name => "Line Chart") do |sheet|
+  sheet.add_row ["First", 1, 5, 7, 9]
+  sheet.add_row ["Second", 5, 2, 14, 9]
+  sheet.add_chart(Axlsx::Line3DChart, :title => "example 6: Line Chart", :rotX => 30, :rotY => 30) do |chart|
+    chart.start_at 0, 2
+    chart.end_at 10, 15
+    chart.add_series :data => sheet["B1:E1"], :title => sheet["A1"], :color => "FF0000"
+    chart.add_series :data => sheet["B2:E2"], :title => sheet["A2"], :color => "00FF00"
+  end
+end
+
+wb.add_worksheet(:name => 'Line Chart with Axis colors') do |sheet|
+  sheet.add_row ["First", 1, 5, 7, 9]
+  sheet.add_row ["Second", 5, 2, 14, 9]
+  sheet.add_chart(Axlsx::Line3DChart, :title => "example 7: Flat Line Chart", :rot_x => 0, :perspective => 0) do |chart|
+    chart.valAxis.color = "FFFF00"
+    chart.catAxis.color = "00FFFF"
+    chart.serAxis.delete = true
+    chart.start_at 0, 2
+    chart.end_at 10, 15
+    chart.add_series :data => sheet["B1:E1"], :title => sheet["A1"], :color => "FF0000"
+    chart.add_series :data => sheet["B2:E2"], :title => sheet["A2"], :color => "00FF00"
+  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"], :color => '00FF00'
+     chart.add_series :xData => sheet["B3:E3"], :yData => sheet["B4:E4"], :title => sheet["A3"], :color => 'FF0000'
+   end
+ end
+
+
+p.validate.each { |e| puts e.message }
+p.serialize 'chart_colors.xlsx'

data/examples/conditional_formatting/example_conditional_formatting.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+
+p = Axlsx::Package.new
+book = p.workbook
+
+# define your regular styles
+percent = book.styles.add_style(:format_code => "0.00%", :border => Axlsx::STYLE_THIN_BORDER)
+money = book.styles.add_style(:format_code => '0,000', :border => Axlsx::STYLE_THIN_BORDER)
+
+# define the style for conditional formatting
+profitable = book.styles.add_style( :fg_color=>"FF428751",
+                                    :type => :dxf)
+
+book.add_worksheet(:name => "Cell Is") do |ws|
+
+  # Generate 20 rows of data
+  ws.add_row ["Previous Year Quarterly Profits (JPY)"]
+  ws.add_row ["Quarter", "Profit", "% of Total"]
+  offset = 3
+  rows = 20
+  offset.upto(rows + offset) do |i|
+    ws.add_row ["Q#{i}", 10000*((rows/2-i) * (rows/2-i)), "=100*B#{i}/SUM(B3:B#{rows+offset})"], :style=>[nil, money, percent]
+  end
+
+# Apply conditional formatting to range B3:B100 in the worksheet
+  ws.add_conditional_formatting("B3:B100", { :type => :cellIs, :operator => :greaterThan, :formula => "100000", :dxfId => profitable, :priority => 1 })
+end
+
+book.add_worksheet(:name => "Color Scale") do |ws|
+  ws.add_row ["Previous Year Quarterly Profits (JPY)"]
+  ws.add_row ["Quarter", "Profit", "% of Total"]
+  offset = 3
+  rows = 20
+  offset.upto(rows + offset) do |i|
+    ws.add_row ["Q#{i}", 10000*((rows/2-i) * (rows/2-i)), "=100*B#{i}/SUM(B3:B#{rows+offset})"], :style=>[nil, money, percent]
+  end
+# Apply conditional formatting to range B3:B100 in the worksheet
+  color_scale = Axlsx::ColorScale.new
+  ws.add_conditional_formatting("B3:B100", { :type => :colorScale, :operator => :greaterThan, :formula => "100000", :dxfId => profitable, :priority => 1, :color_scale => color_scale })
+end
+
+
+book.add_worksheet(:name => "Data Bar") do |ws|
+  ws.add_row ["Previous Year Quarterly Profits (JPY)"]
+  ws.add_row ["Quarter", "Profit", "% of Total"]
+  offset = 3
+  rows = 20
+  offset.upto(rows + offset) do |i|
+    ws.add_row ["Q#{i}", 10000*((rows/2-i) * (rows/2-i)), "=100*B#{i}/SUM(B3:B#{rows+offset})"], :style=>[nil, money, percent]
+  end
+# Apply conditional formatting to range B3:B100 in the worksheet
+  data_bar = Axlsx::DataBar.new
+  ws.add_conditional_formatting("B3:B100", { :type => :dataBar, :dxfId => profitable, :priority => 1, :data_bar => data_bar })
+end
+
+book.add_worksheet(:name => "Icon Set") do |ws|
+  ws.add_row ["Previous Year Quarterly Profits (JPY)"]
+  ws.add_row ["Quarter", "Profit", "% of Total"]
+  offset = 3
+  rows = 20
+  offset.upto(rows + offset) do |i|
+    ws.add_row ["Q#{i}", 10000*((rows/2-i) * (rows/2-i)), "=100*B#{i}/SUM(B3:B#{rows+offset})"], :style=>[nil, money, percent]
+  end
+# Apply conditional formatting to range B3:B100 in the worksheet
+  icon_set = Axlsx::IconSet.new
+  ws.add_conditional_formatting("B3:B100", { :type => :iconSet, :dxfId => profitable, :priority => 1, :icon_set => icon_set })
+end
+
+p.serialize('example_conditional_formatting.xlsx')

data/examples/conditional_formatting/getting_barred.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+p = Axlsx::Package.new
+p.workbook do |wb|
+  # define your regular styles
+  styles = wb.styles
+  title = styles.add_style :sz => 15, :b => true, :u => true
+  default = styles.add_style :border => Axlsx::STYLE_THIN_BORDER
+  header = styles.add_style :bg_color => '00', :fg_color => 'FF', :b => true
+  money = styles.add_style :format_code => '#,###,##0', :border => Axlsx::STYLE_THIN_BORDER
+  percent = styles.add_style :num_fmt => Axlsx::NUM_FMT_PERCENT, :border => Axlsx::STYLE_THIN_BORDER
+
+  # define the style for conditional formatting - its the :dxf bit that counts!
+  profitable =  styles.add_style :fg_color => 'FF428751', :sz => 12, :type => :dxf, :b => true
+
+  wb.add_worksheet(:name => 'Data Bar Conditional Formatting') do  |ws|
+    ws.add_row ['A$$le Q1 Revenue Historical Analysis (USD)'], :style => title
+    ws.add_row
+    ws.add_row ['Quarter', 'Profit', '% of Total'], :style => header
+    ws.add_row ['Q1-2010', '15680000000', '=B4/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2011', '26740000000', '=B5/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2012', '46330000000', '=B6/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2013(est)', '72230000000', '=B7/SUM(B4:B7)'], :style => [default, money, percent]
+
+    ws.merge_cells 'A1:C1'
+
+    # Apply conditional formatting to range B4:B7 in the worksheet
+    data_bar = Axlsx::DataBar.new
+    ws.add_conditional_formatting 'B4:B7', { :type => :dataBar,
+                                             :dxfId => profitable,
+                                             :priority => 1,
+                                             :data_bar => data_bar }
+  end
+end
+p.serialize 'getting_barred.xlsx'

data/examples/conditional_formatting/hitting_the_high_notes.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+p = Axlsx::Package.new
+p.workbook do |wb|
+  # define your regular styles
+  styles = wb.styles
+  title = styles.add_style :sz => 15, :b => true, :u => true
+  default = styles.add_style :border => Axlsx::STYLE_THIN_BORDER
+  header = styles.add_style :bg_color => '00', :fg_color => 'FF', :b => true
+  money = styles.add_style :format_code => '###,###,###,##0', :border => Axlsx::STYLE_THIN_BORDER
+  percent = styles.add_style :num_fmt => Axlsx::NUM_FMT_PERCENT, :border => Axlsx::STYLE_THIN_BORDER
+
+  # define the style for conditional formatting - its the :dxf bit that counts!
+  profitable = styles.add_style :fg_color => 'FF428751', :sz => 12, :type => :dxf, :b => true
+
+  wb.add_worksheet(:name => 'The High Notes') do  |ws|
+    ws.add_row ['A$$le Q1 Revenue Historical Analysis (USD)'], :style => title
+    ws.add_row
+    ws.add_row ['Quarter', 'Profit', '% of Total'], :style => header
+    ws.add_row ['Q1-2010', '15680000000', '=B4/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2011', '26740000000', '=B5/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2012', '46330000000', '=B6/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2013(est)', '72230000000', '=B7/SUM(B4:B7)'], :style => [default, money, percent]
+
+    ws.merge_cells 'A1:C1'
+
+    # Apply conditional formatting to range B4:B7 in the worksheet
+    ws.add_conditional_formatting 'B4:B7', { :type => :cellIs,
+                                             :operator => :greaterThan,
+                                             :formula => '27000000000',
+                                             :dxfId => profitable,
+                                             :priority => 1 }
+  end
+end
+p.serialize 'the_high_notes.xlsx'

data/examples/conditional_formatting/scaled_colors.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+p = Axlsx::Package.new
+p.workbook do |wb|
+  # define your regular styles
+  styles = wb.styles
+  title = styles.add_style :sz => 15, :b => true, :u => true
+  default = styles.add_style :border => Axlsx::STYLE_THIN_BORDER
+  header = styles.add_style :bg_color => '00', :fg_color => 'FF', :b => true
+  money = styles.add_style :format_code => '#,###,##0', :border => Axlsx::STYLE_THIN_BORDER
+  percent = styles.add_style :num_fmt => Axlsx::NUM_FMT_PERCENT, :border => Axlsx::STYLE_THIN_BORDER
+
+  # define the style for conditional formatting - its the :dxf bit that counts!
+  profitable = styles.add_style :fg_color => 'FF428751', :sz => 12, :type => :dxf, :b => true
+
+  wb.add_worksheet(:name => 'Scaled Colors') do  |ws|
+    ws.add_row ['A$$le Q1 Revenue Historical Analysis (USD)'], :style => title
+    ws.add_row
+    ws.add_row ['Quarter', 'Profit', '% of Total'], :style => header
+    ws.add_row ['Q1-2010', '15680000000', '=B4/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2011', '26740000000', '=B5/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2012', '46330000000', '=B6/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2013(est)', '72230000000', '=B7/SUM(B4:B7)'], :style => [default, money, percent]
+
+    ws.merge_cells 'A1:C1'
+
+    # Apply conditional formatting to range B4:B7 in the worksheet
+    color_scale = Axlsx::ColorScale.new
+    ws.add_conditional_formatting 'B4:B7', { :type => :colorScale,
+                                             :operator => :greaterThan,
+                                             :formula => '27000000000',
+                                             :dxfId => profitable,
+                                             :priority => 1,
+                                             :color_scale => color_scale }
+  end
+end
+p.serialize 'scaled_colors.xlsx'

data/examples/conditional_formatting/stop_and_go.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+p = Axlsx::Package.new
+p.workbook do |wb|
+  # define your regular styles
+  styles = wb.styles
+  title = styles.add_style :sz => 15, :b => true, :u => true
+  default = styles.add_style :border => Axlsx::STYLE_THIN_BORDER
+  header = styles.add_style :bg_color => '00', :fg_color => 'FF', :b => true
+  money = styles.add_style :format_code => '#,###,##0', :border => Axlsx::STYLE_THIN_BORDER
+  percent = styles.add_style :num_fmt => Axlsx::NUM_FMT_PERCENT, :border => Axlsx::STYLE_THIN_BORDER
+
+  # define the style for conditional formatting - its the :dxf bit that counts!
+  profitable = styles.add_style :fg_color => 'FF428751', :sz => 12, :type => :dxf, :b => true
+
+  wb.add_worksheet(:name => 'Downtown traffic') do  |ws|
+    ws.add_row ['A$$le Q1 Revenue Historical Analysis (USD)'], :style => title
+    ws.add_row
+    ws.add_row ['Quarter', 'Profit', '% of Total'], :style => header
+    ws.add_row ['Q1-2010', '15680000000', '=B4/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2011', '26740000000', '=B5/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2012', '46330000000', '=B6/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2013(est)', '72230000000', '=B7/SUM(B4:B7)'], :style => [default, money, percent]
+
+    ws.merge_cells 'A1:C1'
+
+    # Apply conditional formatting to range B3:B7 in the worksheet
+    icon_set = Axlsx::IconSet.new
+    ws.add_conditional_formatting 'B3:B7', { :type => :iconSet,
+                                             :dxfId => profitable,
+                                             :priority => 1,
+                                             :icon_set => icon_set }
+  end
+end
+p.serialize 'stop_and_go.xlsx'

data/examples/data_validation.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+
+p = Axlsx::Package.new
+p.workbook.add_worksheet do |ws| 
+  ws.add_data_validation("A10", { 
+    :type => :whole, 
+    :operator => :between, 
+    :formula1 => '5', 
+    :formula2 => '10', 
+    :showErrorMessage => true, 
+    :errorTitle => 'Wrong input', 
+    :error => 'Only values between 5 and 10', 
+    :errorStyle => :information, 
+    :showInputMessage => true, 
+    :promptTitle => 'Be carful!', 
+    :prompt => 'Only values between 5 and 10'})
+  
+  ws.add_data_validation("B10", { 
+    :type => :textLength, 
+    :operator => :greaterThan, 
+    :formula1 => '10', 
+    :showErrorMessage => true, 
+    :errorTitle => 'Text is too long', 
+    :error => 'Max text length is 10 characters', 
+    :errorStyle => :stop, 
+    :showInputMessage => true, 
+    :promptTitle => 'Text length', 
+    :prompt => 'Max text length is 10 characters'})
+  
+  8.times do |i|
+    ws.add_row [nil, nil, i*2]
+  end
+  
+  ws.add_data_validation("C10", { 
+    :type => :list, 
+    :formula1 => 'C1:C8', 
+    :showDropDown => false,
+    :showErrorMessage => true, 
+    :errorTitle => '', 
+    :error => 'Only values from C1:C8', 
+    :errorStyle => :stop, 
+    :showInputMessage => true, 
+    :promptTitle => '', 
+    :prompt => 'Only values from C1:C8'})
+end
+
+p.serialize 'data_validation.xlsx'