axlsx 1.1.4 → 1.3.1

data/.yardopts

@@ -1,5 +1,9 @@
 --protected
 --no-private
 --title "AXLSX"
---files LICENSE
---files CHANGELOG.md
+--readme README.md
+--markup markdown
+--markup-provider kramdown
+-
+CHANGELOG.md
+LICENSE

data/CHANGELOG.md

@@ -1,5 +1,77 @@
 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
+   - added support for two cell anchors for images
+   - test coverage now back up to 100%
+   - bugfix for merge cell sorting algorithm
+   - added fit_to method for page_setup to simplify managing witdh/height
+   - 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.
+   - Support for adding comments to your worksheets
+   - bugfix for applying style to empty cells
+   - bugfix for parsing formula with multiple '='
+
+- **May.3.12:**: 1.1.4 release
+   - MOAR examples
+   - added outline level for rows and columns
+   - rebuild of numeric and axis data sources for charts
+   - added delete to axis
+   - added tick and label mark skipping for cat axis in charts
+   - bugfix for table headers method
+   - sane(er) defaults for chart positioning
+   - bugfix in val_axis_data to properly serialize value axis data. Excel does not mind as it reads from the sheet, but nokogiri has a fit if the elements are empty.
+   - Added support for specifying the color of data series in charts.
+   - bugfix using add_cell on row mismanaged calls to update_column_info.
+
+- ** April.25.12:**: 1.1.3 release
+   - Primarily because I am stupid.....Updates to readme to properly report version, add in missing docs and restructure example directory.
+
+- ** April.25.12:**: 1.1.2 release
+   - Conditional Formatting completely implemented.
+   - refactoring / documentation for Style#add_style
+   - added in label rotation for chart axis labels
+   - bugfix to properly assign style and type info to cells when only partial information is provided in the types/style option
+
 - ** April.18.12**: 1.1.1 release
    - bugfix for autowidth calculations across multiple rows
    - bugfix for dimension calculations with nil cells.

data/README.md

@@ -2,6 +2,11 @@ Axlsx: Office Open XML Spreadsheet Generation
 ====================================
 [![Build Status](https://secure.travis-ci.org/randym/axlsx.png)](http://travis-ci.org/randym/axlsx/)
 
+If you are using axlsx for comercial purposes, or just want to show your
+appreciation for the gem, please don't hesitate to make a donation.
+
+[![Click here to lend your support to: axlsx and make a donation at www.pledgie.com !](http://www.pledgie.com/campaigns/17814.png?skin_name=chrome)](http://www.pledgie.com/campaigns/17814)
+
 **IRC**:[irc.freenode.net / #axlsx](irc://irc.freenode.net/axlsx)
 
 **Git**:[http://github.com/randym/axlsx](http://github.com/randym/axlsx)
@@ -16,7 +21,7 @@ Axlsx: Office Open XML Spreadsheet Generation
 
 **License**: MIT License
 
-**Latest Version**: 1.1.4
+**Latest Version**: 1.3.1
 
 **Ruby Version**: 1.8.7, 1.9.2, 1.9.3
 
@@ -24,19 +29,32 @@ Axlsx: Office Open XML Spreadsheet Generation
 
 **Rubinius Version**: rubinius 2.0.0dev * lower versions may run, this gem always tests against head.
 
-**Release Date**: May 3rd 2012
+**Release Date**: September 30th 2012
 
 If you are working in rails, or with active record see:
-http://github.com/randym/acts_as_xlsx
+* http://github.com/randym/acts_as_xlsx
+acts_as_xlsx is a simple ActiveRecord mixin that lets you generate a workbook with:
+
+    ```ruby
+    Posts.where(created_at > Time.now-30.days).to_xlsx
+    ```
+
+** and **
+
+* http://github.com/straydogstudio/axlsx_rails
+Axlsx_Rails provides an Axlsx renderer so you can move all your spreadsheet code from your controller into view files. Partials are supported so you can organize any code into reusable chunks (e.g. cover sheets, common styling, etc.) You can use it with acts_as_xlsx, placing the to_xlsx call in a view and add ':package => xlsx_package' to the parameter list. Now you can keep your controllers thin!
 
 There are guides for using axlsx and acts_as_xlsx here:
-[http://axlsx.blogspot.com](http://axlsx.blogspot.com)
+[http://axlsx.blog.randym.net](http://axlsx.blog.randym.net)
+
+The examples directory contains a number of more specific examples as
+well.
 
 Synopsis
 --------
 
 Axlsx is an Office Open XML Spreadsheet generator for the Ruby programming language.
-With Axlsx you can create excel worksheets with charts, images (with links), automated and fixed column widths, customized styles, functions, merged cells, auto filters, file and stream serialization  as well as full schema validation. Axlsx excels at helping you generate beautiful Office Open XML Spreadsheet documents without having to understand the entire ECMA specification.
+With Axlsx you can create excel worksheets with charts, images (with links), automated and fixed column widths, customized styles, functions, tables, conditional formatting, print options, comments, merged cells, auto filters, file and stream serialization  as well as full schema validation. Axlsx excels at helping you generate beautiful Office Open XML Spreadsheet documents without having to understand the entire ECMA specification.
 
 ![Screen 1](https://github.com/randym/axlsx/raw/master/examples/sample.png)
 
@@ -63,9 +81,8 @@ Feature List
 
 **9. Cell level style overrides for default and customized style objects
 
-**10. Support for formulas
-
-**11. Support for cell merging as well as column and row outline
+**10. Support for formulas, merging, row and column outlining as well as
+cell level input data validation.
 
 **12. Auto filtering tables with worksheet.auto_filter as well as support for Tables
 
@@ -75,6 +92,15 @@ Feature List
 
 **15. Support for page margins and print options
 
+**16. Support for password and non password based sheet protection.
+
+**17. First stage interoperability support for GoogleDocs, LibreOffice,
+and Numbers
+
+**18. Support for defined names, which gives you repeated header rows for printing.
+
+**19. Data labels for charts as well as series color customization.
+
 Installing
 ----------
 
@@ -86,12 +112,28 @@ To install Axlsx, use the following command:
 ------
 
 The example listing is getting overly large to maintain here.
-If you are using Yard, you will be able to see the examples inline below.
-If not, please refer to the Please see the {file:examples/example.rb} file.
+If you are using Yard, you will be able to see the examples in line below.
+
+Here's a teaser that kicks about 2% of what the gem can do.
+
+```ruby
+Axlsx::Package.new do |p|
+  p.workbook.add_worksheet(:name => "Pie Chart") do |sheet|
+    sheet.add_row ["Simple Pie Chart"]
+    %w(first second third).each { |label| sheet.add_row [label, rand(24)+1] }
+    sheet.add_chart(Axlsx::Pie3DChart, :start_at => [0,5], :end_at => [10, 20], :title => "example 3: Pie Chart") do |chart|
+      chart.add_series :data => sheet["B2:B4"], :labels => sheet["A2:A4"],  :colors => ['FF0000', '00FF00', '0000FF']
+    end
+  end
+  p.serialize('simple.xlsx')
+end
+```
+
+Please see the [examples](https://github.com/randym/axlsx/tree/master/examples/example.rb) for more.
 
 {include:file:examples/example.rb}
 
-There is much, much more you can do with this gem. If you get stuck, grab me on IRC or submit an issue to Github. Chances are that it has already been implemented. If it hasn't - let's take a look at adding it in.
+There is much, much more you can do with this gem. If you get stuck, grab me on IRC or submit an issue to GitHub. Chances are that it has already been implemented. If it hasn't - let's take a look at adding it in.
 
 #Documentation
 --------------
@@ -107,30 +149,61 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem,
 
 #Change log
 ---------
-- ** May.3.12:**: 1.1.4 release
-   - MOAR examples
-   - added outline level for rows and columns
-   - rebuild of numeric and axis data sources for charts
-   - added delete to axis
-   - added tick and label mark skipping for cat axis in charts
-   - bugfix for table headers method
-   - sane(er) defaults for chart positioning
-   - bugfix in val_axis_data to properly serialize value axis data. Excel does not mind as it reads from the sheet, but nokogiri has a fit if the elements are empty.
-   - Added support for specifying the color of data series in charts.
-   - bugfix using add_cell on row mismanaged calls to update_column_info.
-
-- ** April.25.12:**: 1.1.3 release
-   - Primarily because I am stupid.....Updates to readme to properly report version, add in missing docs and restructure example directory.
-
-- ** April.25.12:**: 1.1.2 release
-   - Conditional Formatting completely implemented.
-   - refactoring / documentation for Style#add_style
-   - added in label rotation for chart axis labels
-   - bugfix to properly assign style and type info to cells when only partial information is provided in the types/style option
+- **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
 
 Please see the {file:CHANGELOG.md} document for past release information.
 
+# Known interoperability issues.
+As axslx implements the Office Open XML (ECMA-376 spec) much of the
+functionality is interoperable with other spreadsheet software. Below is
+a listing of some known issues.
+
+1. Libra Office
+   -  You must specify colors for your series. see examples/chart_colors.rb
+for an example.
+   - You must use data in your sheet for charts. You cannot use hard coded
+values.
+   -  Chart axis and gridlines do not render. I have a feeling this is
+related to themes, which axlsx does not implement at this time.
+
+2. Google Docs
+   - Images are known to not work with google docs
+   - border colors do not work
+
+3. Numbers
+   - 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
+
+
 #Thanks!
+
+Open source software is a community effort. None of this could have been
+done without the help of the people below.
+
 --------
 [ochko](https://github.com/ochko) - for performance fixes, kicking the crap out of axlsx and helping to maintain my general sanity.
 
@@ -152,6 +225,16 @@ Please see the {file:CHANGELOG.md} document for past release information.
 
 [scpike](https://github.com/scpike) - for keeping numbers fixed even when they are rational and a super clean implementation of conditional formatting.
 
+[janhuehne](https://github.com/janhuehne) - for working out the decoder ring and adding in cell level validation, and providing a support for window panes.
+
+[rfc2616](https://github.com/rfc2616) - for FINALLY working out the interop issues with google docs.
+
+[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

@@ -9,7 +9,9 @@ task :benchmark do
 end
 
 task :gendoc do
-  system "yardoc"
+  #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
@@ -17,12 +19,18 @@ task :test do
      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/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/basic_charts.rb

@@ -0,0 +1,58 @@
+$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
+    chart.catAxis.tick_lbl_pos = :none
+
+  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
+
+    chart.catAxis.tick_lbl_pos = :none
+  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

@@ -36,7 +36,7 @@ end
    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']
+     chart.add_series :data => sheet["A2:D2"], :labels => sheet["A1:D1"], :colors => ['FF0000', '00FF00', '0000FF', '000000']
    end
  end
 
@@ -45,7 +45,7 @@ end
 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 => 20) do |chart|
+  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"
@@ -53,6 +53,21 @@ wb.add_worksheet(:name => "Line Chart") do |sheet|
   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|

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'