caxlsx 2.0.2

data/examples/extractive.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+
+data = [ ['oil-bbl',9591.411671,8860.714604,8237.936509,7700.523067,7231.831842,6819.307902,6453.297235,6126.251755,5832.182748,5566.276532,5324.618706,5103.992757,4901.730597,4715.600022,4543.718862,4384.488699,4236.543136,4098.707009,3969.963937,3849.430276,3736.33405,3629.997786,3529.824424,3435.28568,3345.912388,3261.286414,3181.033882,3104.819438,3032.341401,2963.327615,2897.531915,2834.731083,2774.722219,2717.320479,2662.357097,2609.677666,2559.140642,2510.616021,2463.984182,2419.134871,2375.966292,2334.384311,2294.301748,2255.637735,2218.317165,2182.270173,2147.431696,2113.741056,2081.141602,2049.580377,2019.007821,1989.377502,1960.645871,1932.772042,1905.71759,1879.446367,1853.924338,1829.119424,1805.001366,1781.541597,1758.713122,1736.490414,1714.849315,1693.766943,1673.22161,1653.192744,1633.660817,1614.607284,1596.014514,1577.865741,1560.145009,1542.837121,1525.927597,1509.402632,1493.249056,1477.454298,1462.006352,1446.893746,1432.105512,1417.631159,1403.460647,1389.584361,1375.993094,1362.678018,1349.630672,1336.842938,1324.307026,1312.015455,1299.961043,1288.136885,1276.536347,1265.153047,1253.980847,1243.013838,1232.246332,1221.672852,1211.288119,1201.087047,1191.064732,1181.216443,1171.537618,1162.023853,1152.670896,1143.474642,1134.431125,1125.536513,1116.787101,1108.179309,1099.709672,1091.37484,1083.171571,1075.096725,1067.147265,1059.320247,1051.612821,1044.022223,1036.545778,1029.180889,1021.92504,1014.775789],
+
+['gas-mcf', 940970.153,836556.732,748476.939,673307.64,608520.158,552204.935,502892.3,459432.263,420911.806,386596.658,355889.491,328299.357,303418.988,280907.679,260478.232,241886.857,224925.287,209414.552,195200.029,182147.455,170139.707,159074.174,148860.596,139419.282,130679.626,122578.864,115061.035,108076.1,101579.19,95529.972,89892.104,84632.762,79722.24,75133.597,70842.349,66826.213,63064.865,59539.742,56233.86,53131.662,50218.869,47482.365,44910.082,42490.907,40214.588,38071.662,36053.382,34151.656,32358.989,30668.434,29073.545,27568.334,26147.237,24805.079,23537.041,22338.633,21205.67,20134.246,19120.717,18161.677,17253.941,16394.533,15580.663,14809.724,14079.269,13387.006,12730.786,12108.59,11518.524,10958.809,10427.774,9923.847,9445.55,8991.492,8560.364,8150.934,7762.041,7392.59,7041.551,6707.951,6390.874,6089.452,5802.871,5530.358,5271.185,5024.664,4790.145,4567.013,4354.687,4152.618,3960.286,3777.198,3602.889,3436.919,3278.87,3128.347,2984.976,2848.401,2718.287,2594.316,2476.184,2363.606,2256.309,2154.037,2056.545,1963.599,1874.982,1790.482,1709.903,1633.054,1559.758,1489.844,1423.151,1359.525,1298.821,1240.899,1185.628,1132.883,1082.544,1034.499],
+
+['water-bbl',940.97,836.557,748.477,673.308,608.52,552.205,502.892,459.432,420.912,386.597,355.889,328.299,303.419,280.908,260.478,241.887,224.925,209.415,195.2,182.147,170.14,159.074,148.861,139.419,130.68,122.579,115.061,108.076,101.579,95.53,89.892,84.633,79.722,75.134,70.842,66.826,63.065,59.54,56.234,53.132,50.219,47.482,44.91,42.491,40.215,38.072,36.053,34.152,32.359,30.668,29.074,27.568,26.147,24.805,23.537,22.339,21.206,20.134,19.121,18.162,17.254,16.395,15.581,14.81,14.079,13.387,12.731,12.109,11.519,10.959,10.428,9.924,9.446,8.991,8.56,8.151,7.762,7.393,7.042,6.708,6.391,6.089,5.803,5.53,5.271,5.025,4.79,4.567,4.355,4.153,3.96,3.777,3.603,3.437,3.279,3.128,2.985,2.848,2.718,2.594,2.476,2.364,2.256,2.154,2.057,1.964,1.875,1.79,1.71,1.633,1.56,1.49,1.423,1.36,1.299,1.241,1.186,1.133,1.083,1.034] ]
+
+p = Axlsx::Package.new
+wb = p.workbook
+wb.add_worksheet(:name => 'volumes') do |ws|
+
+  # perspective, rotX and rotY flatten the 3D chart
+  # hPercent sets the chart height to 100%
+  chart = ws.add_chart(Axlsx::Line3DChart, :perspective => 0, :hPercent => 100, :rotX => 0, :rotY => 0, :start_at => "A4", :end_at => 'M44', :title => 'Monthly forcast for Type Curve Gas secondary - gross ngl')
+
+  # Set up log based scaling and appropriate min/max values for Y axis
+  chart.valAxis.scaling.logBase = 10
+  chart.valAxis.scaling.min = 0.1
+  chart.valAxis.scaling.max = 10000000.0
+
+  # No poing in showing the series axis labels as the chart is flattened!
+  chart.serAxis.delete = true
+
+  # Knock the catAxis labels down to the forced min.
+  chart.catAxis.crosses = :min
+
+  # set up cat labels / markes to show every 12th item
+  chart.catAxis.tickLblSkip = 12
+  chart.catAxis.tickMarkSkip = 12
+
+  #rgb colors for our data series
+  colors = ['00FF00', 'FF0000', '0000FF']
+
+  data.each_with_index do |value, index|
+    ws.add_row value
+    chart.add_series :data => ws.rows.last.cells[(1..value.size-1)], :labels => (0..value.size).map{ |i| i }, :title => ws.rows.last.cells.first, :color => colors[index]
+  end
+end
+
+p.serialize 'extractive.xlsx'

data/examples/ios_preview.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+
+#```ruby
+require 'axlsx'
+
+p = Axlsx::Package.new
+p.use_shared_strings = true
+s = p.workbook.add_worksheet(:name => "Formula test")
+s.add_row [1, 2, 3]
+s.add_row %w(a b c)
+s.add_row ["=SUM(A1:C1)"], :formula_values => [6]
+p.serialize "ios_preview.xlsx"

data/examples/page_setup.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+xls = Axlsx::Package.new
+wb = xls.workbook
+wb.add_worksheet do |ws|
+  # Excel does not currently follow the specification and will ignore paper_width and paper_height so if you need
+  # to for a paper size, be sure to set :paper_size
+  ws.page_setup.set :paper_width => "210mm", :paper_size => 10,  :paper_height => "297mm", :orientation => :landscape
+  ws.add_row %w(AXLSX is cool)
+end
+xls.serialize "page_setup.xlsx"

data/examples/pivot_table.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
+wb = p.workbook
+
+# Create some data in a sheet
+def month
+  %w(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec).sample
+end
+def year
+  %w(2010 2011 2012).sample
+end
+def type
+  %w(Meat Dairy Beverages Produce).sample
+end
+def sales
+  rand(5000)
+end
+def region
+  %w(East West North South).sample
+end
+
+wb.add_worksheet(:name => "Data Sheet") do |sheet|
+  sheet.add_row ['Month', 'Year', 'Type', 'Sales', 'Region']
+  30.times { sheet.add_row [month, year, type, sales, region] }
+  sheet.add_pivot_table 'G4:L17', "A1:E31" do |pivot_table|
+    pivot_table.rows = ['Month', 'Year']
+    pivot_table.columns = ['Type']
+    pivot_table.data = ['Sales']
+    pivot_table.pages = ['Region']
+  end
+end
+
+# Write the excel file
+p.serialize("pivot_table.xlsx")

data/examples/sheet_protection.rb

@@ -0,0 +1,10 @@
+#!/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(:name => 'Open Office') { |ws| ws.sheet_protection.password = 'fish' }
+p.serialize 'sheet_protection.xlsx'
+
+

data/examples/skydrive/real_example.rb

@@ -0,0 +1,63 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../../lib"
+
+require 'axlsx'
+
+Axlsx::Package.new do |p|
+  p.workbook do |wb|
+    styles = wb.styles
+    header     = styles.add_style :bg_color => "DD", :sz => 16, :b => true, :alignment => {:horizontal => :center}
+    tbl_header = styles.add_style :b => true, :alignment => { :horizontal => :center }
+    ind_header = styles.add_style :bg_color => "FFDFDEDF", :b => true, :alignment => {:indent => 1}
+    col_header = styles.add_style :bg_color => "FFDFDEDF", :b => true, :alignment => { :horizontal => :center }
+    label      = styles.add_style :alignment => { :indent => 1 }
+    money      = styles.add_style :num_fmt => 5
+    t_label    = styles.add_style :b => true, :bg_color => "FFDFDEDF"
+    t_money    = styles.add_style :b => true, :num_fmt => 5, :bg_color => "FFDFDEDF"
+
+    wb.add_worksheet do |sheet|
+      sheet.add_row
+      sheet.add_row [nil, "College Budget"], :style => [nil, header]
+      sheet.add_row
+      sheet.add_row [nil, "What's coming in this month.", nil, nil, "How am I doing"], :style => tbl_header
+      sheet.add_row [nil, "Item", "Amount", nil, "Item", "Amount"], :style => [nil, ind_header, col_header, nil, ind_header, col_header]
+      sheet.add_row [nil, "Estimated monthly net income", 500, nil, "Monthly income", "=C9"], :style => [nil, label, money, nil, label, money]
+      sheet.add_row [nil, "Financial aid", 100, nil, "Monthly expenses", "=C27"], :style =>  [nil, label, money, nil, label, money]
+      sheet.add_row [nil, "Allowance from mom & dad", 20000, nil, "Semester expenses", "=F19"], :style =>  [nil, label, money, nil, label, money]
+      sheet.add_row [nil, "Total", "=SUM(C6:C8)", nil, "Difference", "=F6 - SUM(F7:F8)"], :style => [nil, t_label, t_money, nil, t_label, t_money]
+      sheet.add_row
+      sheet.add_row [nil, "What's going out this month.", nil, nil, "Semester Costs"], :style => tbl_header
+      sheet.add_row [nil, "Item", "Amount", nil, "Item", "Amount"], :style => [nil, ind_header, col_header, nil, ind_header, col_header]
+      sheet.add_row [nil, "Rent", 650, nil, "Tuition", 200], :style =>  [nil, label, money, nil, label, money]
+      sheet.add_row [nil, "Utilities", 120, nil, "Lab fees", 50], :style =>  [nil, label, money, nil, label, money]
+      sheet.add_row [nil, "Cell phone", 100, nil, "Other fees", 10], :style =>  [nil, label, money, nil, label, money]
+      sheet.add_row [nil, "Groceries", 75, nil, "Books", 150], :style =>  [nil, label, money, nil, label, money]
+      sheet.add_row [nil, "Auto expenses", 0, nil, "Deposits", 0], :style =>  [nil, label, money, nil, label, money]
+      sheet.add_row [nil, "Student loans", 0, nil, "Transportation", 30], :style =>  [nil, label, money, nil, label, money]
+      sheet.add_row [nil, "Other loans", 350, nil, "Total", "=SUM(F13:F18)"], :style => [nil, label, money, nil, t_label, t_money]
+      sheet.add_row [nil, "Credit cards", 450], :style => [nil, label, money]
+      sheet.add_row [nil, "Insurance", 0], :style => [nil, label, money]
+      sheet.add_row [nil, "Laundry", 10], :style => [nil, label, money]
+      sheet.add_row [nil, "Haircuts", 0], :style => [nil, label, money]
+      sheet.add_row [nil, "Medical expenses", 0], :style => [nil, label, money]
+      sheet.add_row [nil, "Entertainment", 500], :style => [nil, label, money]
+      sheet.add_row [nil, "Miscellaneous", 0], :style => [nil, label, money]
+      sheet.add_row [nil, "Total", "=SUM(C13:C26)"], :style => [nil, t_label, t_money]
+      sheet.add_chart(Axlsx::Pie3DChart) do |chart|
+        chart.title = sheet["B11"]
+        chart.add_series :data => sheet["C13:C26"], :labels => sheet["B13:B26"]
+        chart.start_at 7, 2
+        chart.end_at 12, 15
+      end
+      sheet.add_chart(Axlsx::Bar3DChart, :barDir => :col) do |chart|
+        chart.title = sheet["E11"]
+        chart.add_series :labels => sheet["E13:E18"], :data => sheet["F13:F18"]
+        chart.start_at 7, 16
+        chart.end_at 12, 31
+      end
+      %w(B4:C4 E4:F4 B11:C11 E11:F11 B2:F2).each { |range| sheet.merge_cells(range) }
+      sheet.column_widths 2, nil, nil, 2, nil, nil, 2
+    end
+  end
+  p.use_shared_strings = true
+  p.serialize 'axlsx.xlsx'
+end

data/examples/styles.rb

@@ -0,0 +1,66 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+require 'date'
+
+p = Axlsx::Package.new
+wb = p.workbook
+wb.styles do |style|
+
+  # Date/Time Styles
+  #
+  # The most important thing to remember about OOXML styles is that they are
+  # exclusive. This means that each style must define all the components it
+  # requires to render the cell the way you want. A good example of this is
+  # changing the font size for a date. You cannot specify just the font size,
+  # you must also specify the number format or format code so that renders
+  # know how to display the serialized date float value 
+  #
+  # The parts that make up a custom styles are:
+  #
+  # fonts(Font), fills(Fill), borders(Border) and number formats(NumFmt).
+  # Getting to know those classes will help you make the most out of custom
+  # styling. However axlsx certainly does not expect you to create all those
+  # objects manually.
+  #
+  # workbook.styles.add_style provides a helper method 'add_style' for defining
+  # styles in one go. The docs for that method are definitely worth a read.
+  # @see Style#add_style
+
+  # When no style is applied to a cell, axlsx will automatically apply date/time
+  # formatting to Date and Time objects for you. However, if you are defining
+  # custom styles, you define all aspects of the style you want to apply.
+  #
+  # An aside on styling and auto-width. Auto-width calculations do not
+  # currently take into account any style or formatting you have applied to the
+  # data in your cells as it would require the creation of a rendering engine,
+  # and frankly kill performance. If you are doing a lot of custom formatting,
+  # you are going to be better served by specifying fixed column widths.
+  #
+  # Let's look at an example:
+  #
+  # A style that only applies a font size
+  large_font = wb.styles.add_style :sz => 20
+
+  # A style that applies both a font size and a predefined number format.
+  # @see NumFmt
+  predefined_format = wb.styles.add_style :sz => 20, :num_fmt => 14
+
+  # A style that a applies a font size and a custom formatting code
+  custom_format = wb.styles.add_style :sz => 20, :format_code => 'yyyy-mm-dd'
+
+  # A style that overrides top and left border style
+  override_border = wb.styles.add_style :border => { :style => :thin, :color =>"FAAC58", :edges => [:right, :top, :left] }, :border_top => { :style => :thick, :color => "01DF74" }, :border_left => { :color => "0101DF" }
+
+
+  wb.add_worksheet do |sheet|
+
+    # We then apply those styles positionally
+    sheet.add_row [123, "123", Time.now], style: [nil, large_font, predefined_format]
+    sheet.add_row [123, "123", Date.new(2012, 9, 14)], style: [large_font, nil, custom_format]
+    sheet.add_row [123, "123", Date.new(2000, 9, 12)] # This uses the axlsx default format_code (14)
+    sheet.add_row [123, "123", Time.now], style: [large_font, override_border, predefined_format]
+  end
+
+end
+p.serialize 'styles.xlsx'
+

data/examples/underline.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+p = Axlsx::Package.new
+p.workbook do |wb|
+  wb.styles do |s|
+    no_underline = s.add_style :sz => 10, :b => true, :u => false, :alignment => { :horizontal=> :right }
+    wb.add_worksheet(:name => 'wunderlinen') do |sheet|
+      sheet.add_row %w{a b c really?}, :style => no_underline
+    end
+  end
+end
+p.serialize 'no_underline.xlsx'
+

data/examples/wrap_text.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+p = Axlsx::Package.new
+p.workbook do |wb|
+  wb.styles do |s|
+    wrap_text = s.add_style :fg_color=> "FFFFFF",
+                            :b => true,
+                            :bg_color => "004586",
+                            :sz => 12,
+                            :border => { :style => :thin, :color => "00" },
+                            :alignment => { :horizontal => :center,
+                                            :vertical => :center ,
+                                            :wrap_text => true}
+    wb.add_worksheet(:name => 'wrap text') do |sheet|
+      sheet.add_row ['Torp, White and Cronin'], :style => wrap_text
+      # Forcing the column to be a bit narrow so we can see if the text wrap.
+      sheet.column_info.first.width = 5
+    end
+  end
+end
+p.serialize 'wrap_text.xlsx'

data/lib/axlsx.rb

@@ -0,0 +1,152 @@
+# encoding: UTF-8
+require 'htmlentities'
+require 'axlsx/version.rb'
+
+require 'axlsx/util/simple_typed_list.rb'
+require 'axlsx/util/constants.rb'
+require 'axlsx/util/validators.rb'
+require 'axlsx/util/accessors.rb'
+require 'axlsx/util/serialized_attributes'
+require 'axlsx/util/options_parser'
+# 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 'zip'
+
+#core dependencies
+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.
+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
+    Hash[instance_variables.map { |name| [name.to_s[1..-1], instance_variable_get(name)] }]
+  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(cells, absolute=true)
+    return "" unless cells.first.is_a? Cell
+    cells = sort_cells(cells)
+    reference = "#{cells.first.reference(absolute)}:#{cells.last.reference(absolute)}"
+    if absolute
+      escaped_name = cells.first.row.worksheet.name.gsub "'", "''"
+      "'#{escaped_name}'!#{reference}"
+    else
+      reference
+    end
+  end
+
+  # sorts the array of cells provided to start from the minimum x,y to
+  # the maximum x.y#
+  # @param [Array] cells
+  # @return [Array]
+  def self.sort_cells(cells)
+    cells.sort { |x, y| [x.index, x.row.index] <=> [y.index, y.row.index] }
+  end
+
+  #global reference html entity encoding
+  # @return [HtmlEntities]
+  def self.coder
+    @@coder ||= ::HTMLEntities.new
+  end
+
+  # returns the x, y position of a cell
+  def self.name_to_indices(name)
+    raise ArgumentError, 'invalid cell name' unless name.size > 1
+    # capitalization?!?
+    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][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).to_i - 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
+
+  # Creates an array of individual cell references based on an excel reference range.
+  # @param [String] range A cell range, for example A1:D5
+  # @return [Array]
+  def self.range_to_a(range)
+    range.match(/^(\w+?\d+)\:(\w+?\d+)$/)
+    start_col, start_row = name_to_indices($1)
+    end_col,   end_row   = name_to_indices($2)
+    (start_row..end_row).to_a.map do |row_num|
+      (start_col..end_col).to_a.map do |col_num|
+        "#{col_ref(col_num)}#{row_num+1}"
+      end
+    end
+  end
+
+  # performs the increadible feat of changing snake_case to CamelCase
+  # @param [String] s The snake case string to camelize
+  # @return [String]
+  def self.camel(s="", all_caps = true)
+    s = s.to_s
+    s = s.capitalize if all_caps
+    s.gsub(/_(.)/){ $1.upcase }
+  end
+
+    # returns the provided string with all invalid control charaters
+    # removed.
+    # @param [String] str The sting to process
+    # @return [String]
+    def self.sanitize(str)
+      str.gsub(CONTROL_CHAR_REGEX, '')
+    end
+
+
+  # Instructs the serializer to not try to escape cell value input.
+  # This will give you a huge speed bonus, but if you content has <, > or other xml character data
+  # the workbook will be invalid and excel will complain.
+  def self.trust_input
+    @trust_input ||= false
+  end
+
+  # @param[Boolean] trust_me A boolean value indicating if the cell value content is to be trusted
+  # @return [Boolean]
+  # @see Axlsx::trust_input
+  def self.trust_input=(trust_me)
+    @trust_input = trust_me
+  end
+end