axlsx 1.2.2 → 1.2.3

data/README.md

@@ -1,6 +1,10 @@
 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)
@@ -17,7 +21,7 @@ Axlsx: Office Open XML Spreadsheet Generation
 
 **License**: MIT License
 
-**Latest Version**: 1.2.2
+**Latest Version**: 1.2.3
 
 **Ruby Version**: 1.8.7, 1.9.2, 1.9.3
 
@@ -25,7 +29,7 @@ Axlsx: Office Open XML Spreadsheet Generation
 
 **Rubinius Version**: rubinius 2.0.0dev * lower versions may run, this gem always tests against head.
 
-**Release Date**: August 27th 2012
+**Release Date**: September 8th 2012
 
 If you are working in rails, or with active record see:
 * http://github.com/randym/acts_as_xlsx
@@ -145,6 +149,11 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem,
 
 #Change log
 ---------
+- **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.

data/examples/basic_charts.rb

@@ -24,6 +24,8 @@ end
     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
 
@@ -38,6 +40,8 @@ end
     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
 

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/skydrive/axlsx.csv

@@ -0,0 +1 @@
+,,,,,

data/examples/sprk2012/basics.rb

@@ -0,0 +1,10 @@
+require 'axlsx'
+
+package = Axlsx::Package.new
+package.workbook.add_worksheet(:name => "Basic Worksheet") do |sheet|
+  sheet.add_row ["First Column", "Second", "Third"]
+  sheet.add_row [1, 2, 3]
+end
+package.serialize 'basics.xlsx'
+
+

data/examples/sprk2012/images.rb

@@ -0,0 +1,14 @@
+require 'axlsx'
+package = Axlsx::Package.new
+workbook = package.workbook
+
+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
+  end
+end
+

data/examples/sprk2012/styles.rb

@@ -0,0 +1,19 @@
+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|
+
+    # 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
+  end
+end
+

data/lib/axlsx/drawing/axis.rb

@@ -102,7 +102,7 @@ module Axlsx
 
     # the position of the tick labels
     # must be one of [:nextTo, :high, :low1]
-    def tick_lbl_pos=(v) RestrictionValidator.validate "#{self.class}.tick_lbl_pos", [:nextTo, :high, :low], v; @tick_lbl_pos = v; end
+    def tick_lbl_pos=(v) RestrictionValidator.validate "#{self.class}.tick_lbl_pos", [:nextTo, :high, :low, :none], v; @tick_lbl_pos = v; end
     alias :tickLblPos= :tick_lbl_pos=
 
     # The number format format code for this axis

data/lib/axlsx/package.rb

@@ -242,7 +242,6 @@ module Axlsx
     # @private
     def content_types
       c_types = base_content_types
-
       workbook.drawings.each do |drawing|
         c_types << Axlsx::Override.new(:PartName => "/xl/#{drawing.pn}",
                                        :ContentType => DRAWING_CT)

data/lib/axlsx/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 module Axlsx
   # The current version
-  VERSION="1.2.2"
+  VERSION="1.2.3"
 end

data/lib/axlsx/workbook/worksheet/cell.rb

@@ -380,7 +380,7 @@ module Axlsx
         :boolean
       elsif v.to_s.match(/\A[+-]?\d+?\Z/) #numeric
         :integer
-      elsif v.to_s.match(/\A[+-]?\d+\.\d+?\Z/) #float
+      elsif v.to_s.match(/\A[-+]?[0-9]*\.?[0-9]+([eE][-+]?[0-9]+)?\Z/) #float
         :float
       else
         :string

data/lib/axlsx/workbook/worksheet/page_setup.rb

@@ -20,11 +20,11 @@ module Axlsx
     # * useFirstPageNumber
     # * usePrinterDefaults
     # * verticalDpi
-    
+
     # Number of vertical pages to fit on.
     # @note PageSetup#fit_to is the recomended way to manage page fitting as only specifying one of fit_to_width/fit_to_height will result in the counterpart
     # being set to 1.
-     # @return [Integer]
+    # @return [Integer]
     attr_reader :fit_to_height
 
     # Number of horizontal pages to fit on.
@@ -36,7 +36,7 @@ module Axlsx
     # Orientation of the page (:default, :landscape, :portrait)
     # @return [Symbol]
     attr_reader :orientation 
-    
+
     # Height of paper (string containing a number followed by a unit identifier: "297mm", "11in")
     # @return [String]
     attr_reader :paper_height
@@ -44,11 +44,138 @@ module Axlsx
     # Width of paper (string containing a number followed by a unit identifier: "210mm", "8.5in")
     # @return [String]
     attr_reader :paper_width
-    
+
     # Print scaling (percent value, given as integer ranging from 10 to 400)
     # @return [Integer]
     attr_reader :scale
 
+    # The paper size to use in printing
+    #1 = Letter paper (8.5 in. by 11 in.)
+    #2 = Letter small paper (8.5 in. by 11 in.)
+    #3 = Tabloid paper (11 in. by 17 in.)
+    #4 = Ledger paper (17 in. by 11 in.)
+    #5 = Legal paper (8.5 in. by 14 in.)
+    #6 = Statement paper (5.5 in. by 8.5 in.)
+    #7 = Executive paper (7.25 in. by 10.5 in.)
+    #8 = A3 paper (297 mm by 420 mm)
+    #9 = A4 paper (210 mm by 297 mm)
+    #10 = A4 small paper (210 mm by 297 mm) 
+    #11 = A5 paper (148 mm by 210 mm)
+    #12 = B4 paper (250 mm by 353 mm)
+    #13 = B5 paper (176 mm by 250 mm)
+    #14 = Folio paper (8.5 in. by 13 in.)
+    #15 = Quarto paper (215 mm by 275 mm) 
+    #16 = Standard paper (10 in. by 14 in.)
+    #17 = Standard paper (11 in. by 17 in.)
+    #18 = Note paper (8.5 in. by 11 in.)
+    #19 = #9 envelope (3.875 in. by 8.875 in.) 
+    #20 = #10 envelope (4.125 in. by 9.5 in.) 
+    #21 = #11 envelope (4.5 in. by 10.375 in.) 
+    #22 = #12 envelope (4.75 in. by 11 in.)
+    #23 = #14 envelope (5 in. by 11.5 in.) 24 = C paper (17 in. by 22 in.)
+    #25 = D paper (22 in. by 34 in.)
+    #26 = E paper (34 in. by 44 in.)
+    #27 = DL envelope (110 mm by 220 mm)
+    #28 = C5 envelope (162 mm by 229 mm)
+    #29 = C3 envelope (324 mm by 458 mm)
+    #30 = C4 envelope (229 mm by 324 mm)
+    #31 = C6 envelope (114 mm by 162 mm)
+    #32 = C65 envelope (114 mm by 229 mm)
+    #33 = B4 envelope (250 mm by 353 mm)
+    #34 = B5 envelope (176 mm by 250 mm)
+    #35 = B6 envelope (176 mm by 125 mm)
+    #36 = Italy envelope (110 mm by 230 mm)
+    #37 = Monarch envelope (3.875 in. by 7.5 in.). 38 = 6 3/4 envelope (3.625 in. by 6.5 in.)
+    #39 = US standard fanfold (14.875 in. by 11 in.)
+    #40 = German standard fanfold (8.5 in. by 12 in.)
+    #41 = German legal fanfold (8.5 in. by 13 in.)
+    #42 = ISO B4 (250 mm by 353 mm)
+    #43 = Japanese double postcard (200 mm by 148 mm) 
+    #44 = Standard paper (9 in. by 11 in.)
+    #45 = Standard paper (10 in. by 11 in.)
+    #46 = Standard paper (15 in. by 11 in.)
+    #47 = Invite envelope (220 mm by 220 mm)
+    #50 = Letter extra paper (9.275 in. by 12 in.)
+    #51 = Legal extra paper (9.275 in. by 15 in.)
+    #52 = Tabloid extra paper (11.69 in. by 18 in.)
+    #53 = A4 extra paper (236 mm by 322 mm)
+    #54 = Letter transverse paper (8.275 in. by 11 in.)
+    #55 = A4 transverse paper (210 mm by 297 mm)
+    #56 = Letter extra transverse paper (9.275 in. by 12 in.) 
+    #57 = SuperA/SuperA/A4 paper (227 mm by 356 mm) 
+    #58 = SuperB/SuperB/A3 paper (305 mm by 487 mm) 
+    #59 = Letter plus paper (8.5 in. by 12.69 in.)
+    #60 = A4 plus paper (210 mm by 330 mm)
+    #61 = A5 transverse paper (148 mm by 210 mm)
+    #62 = JIS B5 transverse paper (182 mm by 257 mm)
+    #63 = A3 extra paper (322 mm by 445 mm)
+    #64 = A5 extra paper (174 mm by 235 mm)
+    #65 = ISO B5 extra paper (201 mm by 276 mm)
+    #66 = A2 paper (420 mm by 594 mm)
+    #67 = A3 transverse paper (297 mm by 420 mm)
+    #68 = A3 extra transverse paper (322 mm by 445 mm) 
+    #69 = Japanese Double Postcard (200 mm x 148 mm) 
+    #70 = A6 (105 mm x 148 mm
+    #71 = Japanese Envelope Kaku #2
+    #72 = Japanese Envelope Kaku #3
+    #73 = Japanese Envelope Chou #3
+    #74 = Japanese Envelope Chou #4
+    #75 = Letter Rotated (11in x 8 1/2 11 in)
+    #76 = A3 Rotated (420 mm x 297 mm)
+    #77 = A4 Rotated (297 mm x 210 mm)
+    #78 = A5 Rotated (210 mm x 148 mm)
+    #79 = B4 (JIS) Rotated (364 mm x 257 mm)
+    #80 = B5 (JIS) Rotated (257 mm x 182 mm)
+    #81 = Japanese Postcard Rotated (148 mm x 100 mm)
+    #82 = Double Japanese Postcard Rotated (148 mm x 200 mm) 
+    #83 = A6 Rotated (148 mm x 105 mm)
+    #84 = Japanese Envelope Kaku #2 Rotated
+    #85 = Japanese Envelope Kaku #3 Rotated
+    #86 = Japanese Envelope Chou #3 Rotated
+    #87 = Japanese Envelope Chou #4 Rotated
+    #88 = B6 (JIS) (128 mm x 182 mm)
+    #89 = B6 (JIS) Rotated (182 mm x 128 mm)
+    #90 = (12 in x 11 in)
+    #91 = Japanese Envelope You #4
+    #92 = Japanese Envelope You #4 Rotated
+    #93 = PRC 16K (146 mm x 215 mm)
+    #94 = PRC 32K (97 mm x 151 mm)
+    #95 = PRC 32K(Big) (97 mm x 151 mm)
+    #96 = PRC Envelope #1 (102 mm x 165 mm)
+    #97 = PRC Envelope #2 (102 mm x 176 mm)
+    #98 = PRC Envelope #3 (125 mm x 176 mm)
+    #99 = PRC Envelope #4 (110 mm x 208 mm)
+    #100 = PRC Envelope #5 (110 mm x 220 mm)
+    #101 = PRC Envelope #6 (120 mm x 230 mm)
+    #102 = PRC Envelope #7 (160 mm x 230 mm)
+    #103 = PRC Envelope #8 (120 mm x 309 mm)
+    #104 = PRC Envelope #9 (229 mm x 324 mm)
+    #105 = PRC Envelope #10 (324 mm x 458 mm)
+    #106 = PRC 16K Rotated
+    #107 = PRC 32K Rotated
+    #108 = PRC 32K(Big) Rotated
+    #109 = PRC Envelope #1 Rotated (165 mm x 102 mm)
+    #110 = PRC Envelope #2 Rotated (176 mm x 102 mm)
+    #111 = PRC Envelope #3 Rotated (176 mm x 125 mm)
+    #112 = PRC Envelope #4 Rotated (208 mm x 110 mm)
+    #113 = PRC Envelope #5 Rotated (220 mm x 110 mm)
+    #114 = PRC Envelope #6 Rotated (230 mm x 120 mm)
+    #115 = PRC Envelope #7 Rotated (230 mm x 160 mm)
+    #116 = PRC Envelope #8 Rotated (309 mm x 120 mm)
+    #117 = PRC Envelope #9 Rotated (324 mm x 229 mm)
+    #118 = PRC Envelope #10 Rotated (458 mm x 324 mm)
+    # @return [Integer]
+    attr_reader :paper_size
+
+
+    # Sets the paper size for printing.
+    # @see PageSetup#paper_size
+    # @return integer
+    def paper_size=(size)
+      RestrictionValidator.validate 'paper_size', (1..118), size
+      @paper_size = size
+    end
+
     # Creates a new PageSetup object
     # @option options [Integer] fit_to_height Number of vertical pages to fit on
     # @option options [Integer] fit_to_width Number of horizontal pages to fit on
@@ -56,6 +183,7 @@ module Axlsx
     # @option options [String] paper_height Height of paper (number followed by unit identifier: "297mm", "11in")
     # @option options [String] paper_width Width of paper (number followed by unit identifier: "210mm", "8.5in")
     # @option options [Integer] scale Print scaling (percent value, integer ranging from 10 to 400)
+    # @option options [Integer] paper_size - the size of paper to use
     def initialize(options = {})
       set(options)
     end
@@ -80,7 +208,7 @@ module Axlsx
     def paper_width=(v); Axlsx::validate_number_with_unit(v); @paper_width = v; end
     # @see scale
     def scale=(v); Axlsx::validate_scale_10_400(v); @scale = v; end
-    
+
     # convenience method to achieve sanity when setting fit_to_width and fit_to_height 
     # as they both default to 1 if only their counterpart is specified.
     # @note This method will overwrite any value you explicitly set via the fit_to_height or fit_to_width methods.
@@ -97,8 +225,8 @@ module Axlsx
     # We treat any page set up that has a value set for fit_to_width or fit_to_height value as fit_to_page. 
     # @return [Boolean]
     def fit_to_page?
-       # is there some better what to express this?
-       (fit_to_width != nil || fit_to_height != nil)
+      # is there some better what to express this?
+      (fit_to_width != nil || fit_to_height != nil)
     end
 
     # Serializes the page settings element.

data/lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb

@@ -1,4 +1,5 @@
 module Axlsx
+
   #A collection of hyperlink objects for a worksheet
   class WorksheetHyperlinks < SimpleTypedList
 
@@ -18,6 +19,8 @@ module Axlsx
       @list.last
     end
 
+    # The relationships required by this collection's hyperlinks
+    # @return Array
     def relationships
       return [] if empty?
       map { |hyperlink| hyperlink.relationship }

data/test/workbook/worksheet/tc_cell.rb

@@ -60,7 +60,7 @@ class TestCell < Test::Unit::TestCase
     assert_raise(ArgumentError, "type must be :string, :integer, :float, :date, :time, :boolean") { @c.type = :array }
     assert_nothing_raised("type can be changed") { @c.type = :string }
     assert_equal(@c.value, "1.0", "changing type casts the value")
-
+    assert_equal(:float, @row.add_cell(1.0/10**7).type, 'properly identify exponential floats as float type')
     assert_equal(@row.add_cell(Time.now).type, :time, 'time should be time')
     assert_equal(@row.add_cell(Date.today).type, :date, 'date should be date')
     assert_equal(@row.add_cell(true).type, :boolean, 'boolean should be boolean')
@@ -88,6 +88,7 @@ class TestCell < Test::Unit::TestCase
     assert_equal(@c.send(:cell_type_from_value, -1), :integer)
     assert_equal(@c.send(:cell_type_from_value, true), :boolean)
     assert_equal(@c.send(:cell_type_from_value, false), :boolean)
+    assert_equal(@c.send(:cell_type_from_value, 1.0/10**6), :float)
   end
 
   def test_cast_value

data/test/workbook/worksheet/tc_page_setup.rb

@@ -44,6 +44,11 @@ class TestPageSetup < Test::Unit::TestCase
     assert_equal(50, @ps.scale)
   end
 
+  def test_paper_size
+    assert_raise(ArgumentError) { @ps.paper_size = 119 }
+    assert_nothing_raised {  @ps.paper_size = 10 }
+  end
+
   def test_set_some_values
     @ps.set(:fit_to_width => 2, :orientation => :portrait)
     assert_equal(2, @ps.fit_to_width)
@@ -58,7 +63,7 @@ class TestPageSetup < Test::Unit::TestCase
     assert(@ps.fit_to_width == nil && @ps.fit_to_height == nil)
     assert(@ps.fit_to_page? == false)
   end
-
+  
   def test_with_height_fit_to_page?
     assert(@ps.fit_to_width == nil && @ps.fit_to_height == nil)
     @ps.set(:fit_to_height => 1)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: axlsx
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-27 00:00:00.000000000 Z
+date: 2012-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -277,6 +277,7 @@ files:
 - examples/example_streamed.xlsx
 - examples/extractive.pdf
 - examples/extractive.rb
+- examples/extractive.xlsx
 - examples/hyperlinks.rb
 - examples/hyperlinks.xlsx
 - examples/image1.gif
@@ -284,14 +285,21 @@ files:
 - examples/image1.jpg
 - examples/image1.png
 - examples/no-use_autowidth.xlsx
+- examples/page_setup.rb
+- examples/page_setup.xlsx
 - examples/sample.png
 - examples/scraping_html.rb
 - examples/shared_strings_example.xlsx
 - examples/sheet_protection.rb
 - examples/sheet_view.rb
+- examples/skydrive/axlsx.csv
 - examples/skydrive/axlsx.xlsx
 - examples/skydrive/real_example.rb
+- examples/sprk2012/basics.rb
+- examples/sprk2012/images.rb
+- examples/sprk2012/styles.rb
 - examples/two_cell_anchor_image.rb
+- examples/~$extractive.xlsx
 - LICENSE
 - README.md
 - Rakefile
@@ -411,7 +419,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3191615889138307722
+      hash: 1228635287654264801
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24