axlsx 1.3.6 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5ac3fa208421a6a360082bbc4b4365cc4109e89
-  data.tar.gz: 45f0bc90cd313ae0042a63c868166177ab312184
+  metadata.gz: e930f37405c7605025d570348ef553438e86a17e
+  data.tar.gz: 1b5a4d4eca67a123d7a9f6b83e78e686efd25cf7
 SHA512:
-  metadata.gz: 1c9396cf2d1f3841902f4de9787a7f793fd98795bd21a0a77af383e38c29e8428ea9b8d507d7b9b24e4a25a548ffa561a92c7f9cfb48e59e87fc87ba33a9f390
-  data.tar.gz: 7d48a79d7beb734a9f4d8abe3011df69c10a5fab90b284bbd0924742d66b70adbff793d4462248bafc682418aca7096668b2e49fecb0acb6841fd23823dd239e
+  metadata.gz: 5c28721794fe4270cdbe656a1eae69dcf47026cc16140772ce222cf82647369b4d9316ec012fc63bf118448590f251330092f6a11807d0a6462e398147d5cebe
+  data.tar.gz: f2d55d91d8513f33d530a307a5bb48e30a12368670ebed8ba132daffea2789912fe7e72112e5b6311a32af1dcdafdc7c23e6908ca23efb958ea67cca97125df9

data/.yardopts_guide

@@ -0,0 +1,19 @@
+-t guide
+--title YARD
+-o doc_guide
+--exclude /server/templates/
+--exclude /yard/rubygems/
+--asset docs/images:images
+-
+docs/WhatsNew.md
+docs/GettingStarted.md
+docs/Overview.md
+docs/CodeObjects.md
+docs/Tags.md
+docs/Parser.md
+docs/Handlers.md
+docs/Templates.md
+docs/Glossary.md
+ChangeLog
+LICENSE
+LEGAL

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 CHANGELOG
 ---------
+- **November.25.12**:1.3.4
+  - Support for headers and footers for worksheets
+  - bug fix: Properly escape hyperlink urls
+  - Improvements in color_scale generation for conditional formatting
+  - Improvements in autowidth calculation.
+- **November.8.12**:1.3.3
+  - Patched cell run styles for u and validation for family
+
 - **November.5.12**:1.3.2
   - MASSIVE REFACTORING
   - Patch for apostrophes in worksheet names

data/README.md

@@ -21,25 +21,24 @@ appreciation for the gem, please don't hesitate to make a donation.
 
 **License**: MIT License
 
-**Latest Version**: 1.3.6
+**Latest Version**: 2.0.0
 
-**Ruby Version**: 1.8.7 (soon to be depreciated!!!), 1.9.2, 1.9.3, 2.0.0
+**Ruby Version**: 1.9.2, 1.9.3, 2.0.0
 
-**JRuby Version**: 1.6.7 1.8 and 1.9 modes
+**JRuby Version**: 1.9 modes
 
 **Rubinius Version**: rubinius 2.0.0dev * lower versions may run, this gem always tests against head.
 
-**Release Date**: April 24th 2013
+**Release Date**: September 12th 2013
 
 If you are working in rails, or with active record see:
 [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
-    ```
-
+```ruby
+Posts.where(created_at > Time.now-30.days).to_xlsx
+```
 
 ** and **
 
@@ -71,46 +70,49 @@ With Axlsx you can create excel worksheets with charts, images (with links), aut
 Feature List
 ------------
 
-**1. Author xlsx documents: Axlsx is made to let you easily and quickly generate professional xlsx based reports that can be validated before serialization.
+1. Author xlsx documents: Axlsx is made to let you easily and quickly generate professional xlsx based reports that can be validated before serialization.
 
-**2. Generate 3D Pie, Line, Scatter and Bar Charts: With Axlsx chart generation and management is as easy as a few lines of code. You can build charts based off data in your worksheet or generate charts without any data in your sheet at all. Customize gridlines, label rotation and series colors as well.
+2. Generate 3D Pie, Line, Scatter and Bar Charts: With Axlsx chart generation and management is as easy as a few lines of code. You can build charts based off data in your worksheet or generate charts without any data in your sheet at all. Customize gridlines, label rotation and series colors as well.
 
-**3. Custom Styles: With guaranteed document validity, you can style borders, alignment, fills, fonts, and number formats in a single line of code. Those styles can be applied to an entire row, or a single cell anywhere in your workbook.
+3. Custom Styles: With guaranteed document validity, you can style borders, alignment, fills, fonts, and number formats in a single line of code. Those styles can be applied to an entire row, or a single cell anywhere in your workbook.
 
-**4. Automatic type support: Axlsx will automatically determine the type of data you are generating. In this release Float, Integer, String, Date, Time and Boolean types are automatically identified and serialized to your spreadsheet.
+4. Automatic type support: Axlsx will automatically determine the type of data you are generating. In this release Float, Integer, String, Date, Time and Boolean types are automatically identified and serialized to your spreadsheet.
 
-**5. Automatic and fixed column widths: Axlsx will automatically determine the appropriate width for your columns based on the content in the worksheet, or use any value you specify for the really funky stuff.
+5. Automatic and fixed column widths: Axlsx will automatically determine the appropriate width for your columns based on the content in the worksheet, or use any value you specify for the really funky stuff.
 
-**6. Support for automatically formatted 1904 and 1900 epochs configurable in the workbook.
+6. Support for automatically formatted 1904 and 1900 epochs configurable in the workbook.
 
-**7. Add jpg, gif and png images to worksheets with hyperlinks
+7. Add jpg, gif and png images to worksheets with hyperlinks
 
-**8. Reference cells in your worksheet with "A1" and "A1:D4" style references or from the workbook using "Sheet1!A3:B4" style references
+8. Reference cells in your worksheet with "A1" and "A1:D4" style references or from the workbook using "Sheet1!A3:B4" style references
 
-**9. Cell level style overrides for default and customized style objects
+9. Cell level style overrides for default and customized style objects
 
-**10. Support for formulas, merging, row and column outlining as well as
+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
+12. Auto filtering tables with worksheet.auto_filter as well as support for Tables
 
-**13. Export using shared strings or inline strings so we can inter-op with iWork Numbers (sans charts for now).
+13. Export using shared strings or inline strings so we can inter-op with iWork Numbers (sans charts for now).
 
-**14. Output to file or StringIO
+14. Output to file or StringIO
 
-**15. Support for page margins and print options
+15. Support for page margins and print options
 
-**16. Support for password and non password based sheet protection.
+16. Support for password and non password based sheet protection.
 
-**17. First stage interoperability support for GoogleDocs, LibreOffice,
+17. First stage interoperability support for GoogleDocs, LibreOffice,
 and Numbers
 
-**18. Support for defined names, which gives you repeated header rows for printing.
+18. Support for defined names, which gives you repeated header rows for printing.
+
+19. Data labels for charts as well as series color customization.
 
-**19. Data labels for charts as well as series color customization.
+20. Support for sheet headers and footers
 
-**20. Support for sheet headers and footers
+21. Pivot Tables
 
+22. Page Breaks
 
 Installing
 ----------
@@ -148,6 +150,7 @@ There is much, much more you can do with this gem. If you get stuck, grab me on
 
 #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:
 
      gem install yard
@@ -156,10 +159,29 @@ This gem is 100% documented with YARD, an exceptional documentation library. To
 
 #Specs
 ------
+
 This gem has 100% test coverage using test/unit. To execute tests for this gem, simply run rake in the gem directory.
 
 #Change log
 ---------
+
+- **September.12.13**:2.0.0
+  - DROPPED support for ruby 1.8.7
+  - Altered readme to link to contributors
+  - Lots of improvements to make charts and relations more stable.
+  - Patched color param mutation.
+  - Data sourced for pivot tables can now come from other sheets.
+  - Altered image file extension comparisons to be case insensitive.
+  - Added control character sanitization to shared strings.
+  - Added page breaks. see examples/example.rb for an example.
+  - Bugfix: single to dual cell anchors for images now swap properly so you can set the end_at position during instantiation, in a block or directly on the image.
+  - Improved how we convert date/time to include the UTC offset when provided.
+  - Pinned rubyzip to 0.9.9 for those who are not ready to go up. Please note that release 2.0.1 and on will be using the 1.n.n series of rubyzip
+  - Bugfix: transposition of cells for Worksheet#cols now supports
+    incongruent column counts.counts
+  - Added space preservation for cell text. This will allow whitespace
+    in cell text both when using shared strings and when serializing
+    directly to the cell.
 - **April.24.13**:1.3.6
   - Fixed LibreOffice/OpenOffice issue to properly apply colors to lines
     in charts.
@@ -180,13 +202,6 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem,
   - Added support for descrete border edge styles
   - Improved validation of sheet names
   - Added support for formula value caching so that iOS and OSX preview can show the proper values. See Cell.add_row and the formula_values option.
-- **November.25.12**:1.3.4
-  - Support for headers and footers for worksheets
-  - bug fix: Properly escape hyperlink urls
-  - Improvements in color_scale generation for conditional formatting
-  - Improvements in autowidth calculation.
-- **November.8.12**:1.3.3
-  - Patched cell run styles for u and validation for family
 
 Please see the {file:CHANGELOG.md} document for past release information.
 
@@ -227,55 +242,13 @@ p.serialize('simple.xlsx')
 #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.
-
-[kleine2](https://github.com/kleine2) - for generously donating in return for the image hyperlink feature.
-
-[ffmike](https://github.com/ffmike) - for knocking down an over restrictive i18n dependency, massive patience and great communication skills.
-
-[JonathanTron](https://github.com/JonathanTron) - for giving the gem some style, and making sure it applies.
-
-[JosephHalter](https://github.com/JosephHalter) - for making sure we arrive at the right time on the right date.
-
-[noniq](https://github.com/noniq) - for keeping true to the gem's style, and making sure what we put on paper does not get marginalized.
-
-[jurriaan](https://github.com/jurriaan) - for showing there is more than one way to skin a cat, and work with rows while you are at it.
-
-[joekain](https://github.com/joekain) - for keeping our references working even in the double digits!
-
-[moskrin](https://github.com/moskrin) - for keeping border creation on the edge.
-
-[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/straydogstudio) - 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.
-
-[adammathys](https://github.com/adammathys) - For getting our head in the
-air and our feet on the ground.
-
-[raiis](https://github.com/raiis) - For letting us specify diffent border styles on any edge.
-
-[alexrothenberg](https://github.com/alexrothenberg) - For an outstanding implementation of PivotTables, one of the last BIG chunks missing from the spec.
-
-[ball-hayden](https://github.com/ball-hayden) - For making sure we only get the right characters in our sheet names.
-
-[nibus](https://github.com/nibus) - For patching sheet name uniqueness.
+done without the help of these awesome folks.
 
-[scambra](https://github.com/scambra) - for keeping our lines in line!
+[contributors](https://github.com/randym/axlsx/graphs/contributors)
 
 #Copyright and License
 ----------
 
-Axlsx © 2011-2013 by [Randy Morgan](mailto:digial.ipseity@gmail.com). 
+Axlsx © 2011-2013 by [Randy Morgan](mailto:digial.ipseity@gmail.com).
 
 Axlsx is licensed under the MIT license. Please see the LICENSE document for more information.

data/Rakefile

@@ -24,11 +24,6 @@ task :test do
      end
 end
 
-task :report do
-  require 'cover_me'
-  CoverMe.complete!
-end
-
 task :release => :build do
   system "gem push axlsx-#{Axlsx::VERSION}.gem"
 end

data/examples/2010_comments.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+
+#```ruby
+require 'axlsx'
+p = Axlsx::Package.new
+p.workbook.add_worksheet(:name => 'Excel 2010 comments') do |sheet|
+  sheet.add_row ['Cell with visible comment']
+  sheet.add_row
+  sheet.add_row
+  sheet.add_row ['Cell with hidden comment']
+
+  sheet.add_comment :ref => 'A1', :author => 'XXX', :text => 'Visibile'
+  sheet.add_comment :ref => 'A4', :author => 'XXX', :text => 'Hidden', :visible => false
+end
+p.serialize('excel_2010_comment_test.xlsx')

data/examples/anchor_swapping.rb

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+xls = Axlsx::Package.new
+wb = xls.workbook
+wb.add_worksheet do |ws|
+  img = File.expand_path('../image1.jpeg', __FILE__)
+  ws.add_image(:image_src => img) do |image|
+    image.start_at 2, 2
+    image.end_at 5, 5
+  end
+end
+wb.add_worksheet do |ws|
+  img = File.expand_path('../image1.jpeg', __FILE__)
+  ws.add_image(:image_src => img, :start_at => "B2") do |image|
+    image.width = 70
+    image.height = 50
+  end
+end
+wb.add_worksheet do |ws|
+  img = File.expand_path('../image1.jpeg', __FILE__)
+  ws.add_image(:image_src => img, :start_at => [1,1]) do |image|
+    image.end_at "E7"
+  end
+end
+
+
+
+xls.serialize 'anchor.xlsx'

data/examples/example.rb

@@ -46,6 +46,8 @@ examples << :streaming
 examples << :shared_strings
 examples << :no_autowidth
 examples << :cached_formula
+examples << :page_breaks
+
 p = Axlsx::Package.new
 wb = p.workbook
 #```
@@ -57,6 +59,7 @@ if examples.include? :basic
   wb.add_worksheet(:name => "Basic Worksheet") do |sheet|
     sheet.add_row ["First Column", "Second", "Third"]
     sheet.add_row [1, 2, 3]
+    sheet.add_row ['     preserving whitespace']
   end
 end
 #```
@@ -309,6 +312,7 @@ end
 
 #```ruby
 if examples.include? :mbcs
+  wb.styles.fonts.first.name = 'Arial Unicode MS'
   wb.add_worksheet(:name => "日本語でのシート名") do |sheet|
     sheet.add_row ["日本語"]
     sheet.add_row ["华语/華語"]
@@ -640,6 +644,7 @@ if examples.include? :sheet_view
   end
 end
 
+
 # conditional formatting
 #
 if examples.include? :conditional_formatting
@@ -710,7 +715,17 @@ if examples.include? :conditional_formatting
   end
 end
 
-##Validate and Serialize
+# Page Breaks
+if examples.include? :page_breaks
+  ws = wb.add_worksheet(:name => "page breaks") do |sheet|
+    sheet.add_row ["A"] * 10
+    sheet.add_row ["A"] * 10
+    sheet.add_page_break("B2")
+    sheet.sheet_view.view = :page_layout # so you can see the breaks!
+  end
+end
+
+#Validate and Serialize
 
 #```ruby
 # Serialize directly to file

data/examples/pivot_table.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+
 $LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
 require 'axlsx'
 

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/lib/axlsx.rb

@@ -127,6 +127,14 @@ module Axlsx
     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

data/lib/axlsx/doc_props/core.rb

@@ -8,14 +8,19 @@ module Axlsx
  
     # Creates a new Core object.
     # @option options [String] creator
+    # @option options [Time] created
     def initialize(options={})
       @creator = options[:creator] || 'axlsx'
+      @created = options[:created]
     end
 
     # The author of the document. By default this is 'axlsx'
     # @return [String]
     attr_accessor :creator
 
+    # Creation time of the document. If nil, the current time will be used.
+    attr_accessor :created
+
     # serializes the core.xml document
     # @return [String]
     def to_xml_string(str = '')
@@ -24,7 +29,7 @@ module Axlsx
       str << 'xmlns:dcmitype="' << CORE_NS_DCMIT << '" xmlns:dcterms="' << CORE_NS_DCT << '" '
       str << 'xmlns:xsi="' << CORE_NS_XSI << '">'
       str << '<dc:creator>' << self.creator << '</dc:creator>'
-      str << '<dcterms:created xsi:type="dcterms:W3CDTF">' << Time.now.strftime('%Y-%m-%dT%H:%M:%S') << 'Z</dcterms:created>'
+      str << '<dcterms:created xsi:type="dcterms:W3CDTF">' << (created || Time.now).strftime('%Y-%m-%dT%H:%M:%S') << 'Z</dcterms:created>'
       str << '<cp:revision>0</cp:revision>'
       str << '</cp:coreProperties>'
     end

data/lib/axlsx/drawing/axes.rb

@@ -5,9 +5,11 @@ module Axlsx
   class Axes
 
     # @param [Hash] options options used to generate axis each key
-    # should be an axis name like :val_axix and its value should be the
-    # class of the axis type to construct.
+    # should be an axis name like :val_axis and its value should be the
+    # class of the axis type to construct. The :cat_axis, if there is one,
+    # must come first (we assume a Ruby 1.9+ Hash or an OrderedHash).
     def initialize(options={})
+      raise(ArgumentError, "CatAxis must come first") if options.keys.include?(:cat_axis) && options.keys.first != :cat_axis
       options.each do |name, axis_class|
         add_axis(name, axis_class)
       end
@@ -28,7 +30,9 @@ module Axlsx
     # serialized. Otherwise, each axis is serialized in full. 
     def to_xml_string(str = '', options = {})
       if options[:ids]
-        axes.inject(str) { |string, axis| string << '<c:axId val="' << axis[1].id.to_s << '"/>' }
+        # CatAxis must come first in the XML (for Microsoft Excel at least)
+        sorted = axes.sort_by { |name, axis| axis.kind_of?(CatAxis) ? 0 : 1 }
+        sorted.inject(str) { |string, axis| string << '<c:axId val="' << axis[1].id.to_s << '"/>' }        
       else
         axes.each { |axis| axis[1].to_xml_string(str) }
       end