axlsx 1.2.3 → 1.3.1

data/.yardopts

@@ -4,5 +4,6 @@
 --readme README.md
 --markup markdown
 --markup-provider kramdown
---files CHANGELOG.md, LICENSE
---list-undoc
+-
+CHANGELOG.md
+LICENSE

data/CHANGELOG.md

@@ -1,5 +1,39 @@
 CHANGELOG
 ---------
+- **August.27.12**: 1.2.2
+   - minor patch for auto-filters
+   - minor documentation improvements.
+- **August.12.12**: 1.2.1
+   - Add support for hyperlinks in worksheets
+   - Fix example that was using old style cell merging with concact.
+   - Fix bug that occurs when calculating the font_size for cells that use a user specified style which does not define sz
+- **August.5.12**: 1.2.0
+   - rebuilt worksheet serialization to clean up the code base a bit.
+   - added data labels for charts
+   - added table header printing for each sheet via defined_name. This
+     means that when you print your worksheet, the header rows show for every page
+- **July.??.12**: 1.1.9 release
+   - lots of code clean up for worksheet
+   - added in data labels for pie charts, line charts and bar charts.
+   - bugfix chard with data in a sheet that has a space in the name are
+     now auto updating formula based values
+- **July.14.12**: 1.1.8 release
+   - added html entity encoding for sheet names. This allows you to use
+     characters like '<' and '&' in your sheet names.
+   - new - first round google docs interoperability
+   - added filter to strip out control characters from cell data.
+   - added in interop requirements so that charts are properly exported
+     to PDF from Libra Office
+   - various readability improvements and work standardizing attribute
+     names to snake_case. Aliases are provided for backward compatiblity 
+- **June.11.12**: 1.1.7 release
+   - fix chart rendering issue when label offset is specified as a
+     percentage in serialization and ensure that formula are not stored
+in value caches
+   - fix bug that causes repair warnings when using a text only title reference.
+   - Add title property to axis so you can lable the x/y/series axis for
+     charts.
+   - Add sheet views with panes
 - **May.30.12**: 1.1.6 release
    - data protection with passwords for sheets
    - cell level input validators
@@ -10,7 +44,6 @@ CHANGELOG
    - added ph (phonetics) and s (style) attributes for row.
    - resolved all warnings generating from this gem.
    - improved comment relationship management for multiple comments
-
 - **May.13.12**: 1.1.5 release
    - MOAR print options! You can now specify paper size, orientation,
      fit to width, page margings and gridlines for printing.

data/README.md

@@ -21,7 +21,7 @@ appreciation for the gem, please don't hesitate to make a donation.
 
 **License**: MIT License
 
-**Latest Version**: 1.2.3
+**Latest Version**: 1.3.1
 
 **Ruby Version**: 1.8.7, 1.9.2, 1.9.3
 
@@ -29,7 +29,7 @@ appreciation for the gem, please don't hesitate to make a donation.
 
 **Rubinius Version**: rubinius 2.0.0dev * lower versions may run, this gem always tests against head.
 
-**Release Date**: September 8th 2012
+**Release Date**: September 30th 2012
 
 If you are working in rails, or with active record see:
 * http://github.com/randym/acts_as_xlsx
@@ -149,45 +149,19 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem,
 
 #Change log
 ---------
+- **September.30.12**: 1.3.1
+  - Improved control character handling
+  - Added stored auto filter values and date grouping items
+  - Improved support for autowidth when custom styles are applied
+  - Added support for table style info that lets you take advantage of
+    all the predefined table styles.
+  - Improved style management for fonts so they merge undefined values
+    from the initial master.
 - **September.8.12**: 1.2.3
   - enhance exponential float/bigdecimal values rendering as strings intead
     of 'numbers' in excel.
   - added support for :none option on chart axis labels
   - added support for paper_size option on worksheet.page_setup
-- **August.27.12**: 1.2.2
-   - minor patch for auto-filters
-   - minor documentation improvements.
-- **August.12.12**: 1.2.1
-   - Add support for hyperlinks in worksheets
-   - Fix example that was using old style cell merging with concact.
-   - Fix bug that occurs when calculating the font_size for cells that use a user specified style which does not define sz
-- **August.5.12**: 1.2.0
-   - rebuilt worksheet serialization to clean up the code base a bit.
-   - added data labels for charts
-   - added table header printing for each sheet via defined_name. This
-     means that when you print your worksheet, the header rows show for every page
-- **July.??.12**: 1.1.9 release
-   - lots of code clean up for worksheet
-   - added in data labels for pie charts, line charts and bar charts.
-   - bugfix chard with data in a sheet that has a space in the name are
-     now auto updating formula based values
-- **July.14.12**: 1.1.8 release
-   - added html entity encoding for sheet names. This allows you to use
-     characters like '<' and '&' in your sheet names.
-   - new - first round google docs interoperability
-   - added filter to strip out control characters from cell data.
-   - added in interop requirements so that charts are properly exported
-     to PDF from Libra Office
-   - various readability improvements and work standardizing attribute
-     names to snake_case. Aliases are provided for backward compatiblity 
-- **June.11.12**: 1.1.7 release
-   - fix chart rendering issue when label offset is specified as a
-     percentage in serialization and ensure that formula are not stored
-in value caches
-   - fix bug that causes repair warnings when using a text only title reference.
-   - Add title property to axis so you can lable the x/y/series axis for
-     charts.
-   - Add sheet views with panes
 
 Please see the {file:CHANGELOG.md} document for past release information.
 
@@ -209,7 +183,19 @@ related to themes, which axlsx does not implement at this time.
    - border colors do not work
 
 3. Numbers
-   - you must set 'use_shared_strings' to true
+   - you must set 'use_shared_strings' to true. This is most
+     conveniently done just before rendering by calling Package.use_shared_strings = true prior to serialization.
+
+```ruby
+p = Axlsx::Package.new
+p.workbook.add_worksheet(:name => "Basic Worksheet") do |sheet|
+  sheet.add_row ["First Column", "Second", "Third"]
+  sheet.add_row [1, 2, 3]
+end
+p.use_shared_strings = true
+p.serialize('simple.xlsx')
+```
+
    - charts do not render
 
 
@@ -246,6 +232,9 @@ done without the help of the people below.
 [straydogstudio](https://github.com/straydocstudio) - For making an AWESOME axlsx templating gem for rails.
 
 [MitchellAJ](https://github.com/MitchellAJ) - For catching a bug in font_size calculations, finding some old code in an example and above all for reporting all of that brilliantly
+
+[ebenoist](https://github.com/ebenoist) - For taking control of control characters and keeping what is between the lines, between the lines.
+
 #Copyright and License
 ----------
 

data/Rakefile

@@ -11,7 +11,7 @@ end
 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"
+    #system "yard stats --list-undoc"
 end
 
 task :test do

data/examples/auto_filter.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+Axlsx::Package.new do |p|
+  p.workbook.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.auto_filter = 'A2:D5' 
+    sheet.auto_filter.add_column 3, :filters, :filter_items => ['1.9.2']
+  end
+end.serialize('auto_filter.xlsx')

data/examples/example.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby -w -s
 # -*- coding: utf-8 -*-
-$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+# $LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
 
 #```ruby
 require 'axlsx'
@@ -190,6 +190,7 @@ wb.add_worksheet(:name => "Auto Filter") do |sheet|
   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.auto_filter = "A2:D5"
+  sheet.auto_filter.add_column 3, :filters, :filter_items => ['1.9.2', '1.8.7']
 end
 #```
 
@@ -315,7 +316,7 @@ wb.add_worksheet(:name => "Table") do |sheet|
   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'
+  sheet.add_table "A2:D5", :name => 'Build Matrix', :style_info => { :name => "TableStyleMedium23" }
 end
 #```
 

data/examples/skydrive/real_example.rb

@@ -5,14 +5,14 @@ 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}
+    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"
+    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

data/examples/sprk2012/basics.rb

@@ -1,3 +1,4 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../../lib"
 require 'axlsx'
 
 package = Axlsx::Package.new

data/examples/sprk2012/images.rb

@@ -1,14 +1,9 @@
-require 'axlsx'
-package = Axlsx::Package.new
-workbook = package.workbook
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../../lib"
 
-workbook.add_worksheet(:name => "Image with Hyperlink") do |sheet|
-  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
-    image.hyperlink.tooltip = "Labeled Link"
-    image.start_at 2, 2
+require 'axlsx'
+package = Axlsx::Package.new do |package|
+  package.workbook.add_worksheet(:name => "imagex") do |sheet|
+    img_path = File.expand_path('../../image1.jpeg', __FILE__)
+    sheet.add_image(:image_src => img_path, :width => 720, :height => 666, :start_at => [2,2])
   end
-end
-
+end.serialize 'images.xlsx'

data/examples/sprk2012/line_chart.rb

@@ -0,0 +1,56 @@
+#!/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] ]
+
+package = Axlsx::Package.new
+package.workbook.add_worksheet(:name => 'volumes') do |ws|
+
+  # perspective, rotX and rotY flatten the 3D chart
+  # hPercent sets the chart height to 100%
+  chart_options = {  :perspective => 0,
+                     :hPercent => 100,
+                     :rotX => 0,
+                     :rotY => 0,
+                     :start_at => "A4",
+                     :end_at => 'M44',
+                     :title => 'Monthly forcast for Type Curve Gas secondary - gross ngl' }
+
+  chart = ws.add_chart(Axlsx::Line3DChart, chart_options)
+
+  # 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
+
+package.serialize 'line_chart.xlsx'
+

data/examples/sprk2012/styles.rb

@@ -1,19 +1,20 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../../lib"
+
 require 'axlsx'
 package = Axlsx::Package.new
-workbook = package.workbook
-
-workbook.styles do |s|
-
-  black_cell = s.add_style :bg_color => "00", :fg_color => "FF", :sz => 14, :alignment => { :horizontal=> :center }
-  blue_cell =  s.add_style  :bg_color => "0000FF", :fg_color => "FF", :sz => 20, :alignment => { :horizontal=> :center }
-
-  wb.add_worksheet(:name => "Styles") do |sheet|
+package.workbook do |workbook|
+  workbook.styles do |s|
+    black_cell = s.add_style :bg_color => "00", :fg_color => "FF", :sz => 14, :alignment => { :horizontal=> :center }
+    blue_cell =  s.add_style  :bg_color => "0000FF", :fg_color => "FF", :sz => 20, :alignment => { :horizontal=> :center }
 
-    # Applies the black_cell style to the first and third cell, and the blue_cell style to the second.
-    sheet.add_row ["Text Autowidth", "Second", "Third"], :style => [black_cell, blue_cell, black_cell]
+    workbook.add_worksheet(:name => "Styles") do |sheet|
+      # Applies the black_cell style to the first and third cell, and the blue_cell style to the second.
+      sheet.add_row ["Text Autowidth", "Second", "Third"], :style => [black_cell, blue_cell, black_cell]
 
-    # Applies the thin border to all three cells
-    sheet.add_row [1, 2, 3], :style => Axlsx::STYLE_THIN_BORDER
+      # Applies the thin border to all three cells
+      sheet.add_row [1, 2, 3], :style => Axlsx::STYLE_THIN_BORDER
+    end
   end
 end
+package.serialize 'styles.xlsx'
 

data/examples/styles.rb

@@ -0,0 +1,62 @@
+$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'
+
+
+  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)
+  end
+
+end
+p.serialize 'styles.xlsx'
+