axlsx 1.3.4 → 1.3.5

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.3.4
+**Latest Version**: 1.3.5
 
 **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**: November ??th 2012
+**Release Date**: February 4th 2013
 
 If you are working in rails, or with active record see:
 * http://github.com/randym/acts_as_xlsx
@@ -152,6 +152,19 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem,
 
 #Change log
 ---------
+- **February.4.13**:1.3.5
+  - converted vary_colors for chart data to instance variable with appropriate defulats for the various charts.
+  - Added trust_input method on Axlsx to instruct the serializer to skip HTML escaping. This will give you a tremendous performance boost,
+    Please be sure that you will never have <, >, etc in your content or the XML will be invalid.
+  - Rewrote cell serialization to improve performance
+  - Added iso_8601 type to support text based date and time management.
+  - Bug fix for relationahip management in drawings when you add images
+    and charts to the same worksheet drawing.
+  - Added outline_level_rows and outline_level_columns to worksheet to simplify setting up outlining in the worksheet.
+  - Added support for pivot tables
+  - 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
@@ -240,11 +253,20 @@ done without the help of the people below.
 
 [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) - Fgr getting our head in the
+[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 unequeness.
+
 #Copyright and License
 ----------
 
-Axlsx &copy; 2011-2012 by [Randy Morgan](mailto:digial.ipseity@gmail.com). Axlsx is
-licensed under the MIT license. Please see the LICENSE document for more information.
+Axlsx &copy; 2011-2012 by [Randy Morgan](mailto:digial.ipseity@gmail.com). 
+
+Axlsx is licensed under the MIT license. Please see the LICENSE document for more information.

data/examples/example.rb

@@ -14,6 +14,7 @@ examples << :surrounding_border
 examples << :deep_custom_borders
 examples << :row_column_style
 examples << :fixed_column_width
+examples << :outline_level
 examples << :merge_cells
 examples << :images
 examples << :format_dates
@@ -21,6 +22,7 @@ examples << :mbcs
 examples << :formula
 examples << :auto_filter
 examples << :data_types
+examples << :override_data_types
 examples << :hyperlinks
 examples << :number_currency_format
 examples << :venezuela_currency
@@ -43,7 +45,7 @@ examples << :conditional_formatting
 examples << :streaming
 examples << :shared_strings
 examples << :no_autowidth
-
+examples << :cached_formula
 p = Axlsx::Package.new
 wb = p.workbook
 #```
@@ -237,6 +239,17 @@ if examples.include? :fixed_column_width
     sheet.column_widths nil, 3, 5, nil
   end
 end
+
+#```ruby
+if examples.include? :outline_level
+  wb.add_worksheet(name: 'outline_level') do |sheet|
+    sheet.add_row [1, 2, 3, Time.now, 5, 149455.15]
+    sheet.add_row [1, 2, 5, 6, 5,14100.19]
+    sheet.add_row [9500002267, 1212, 1212, 5,14100.19]
+    sheet.outline_level_rows 0, 2
+    sheet.outline_level_columns 0, 2
+  end
+end
 ##```
 
 ##Merging Cells.
@@ -344,6 +357,12 @@ if examples.include? :data_types
   end
 end
 
+#```ruby
+if examples.include? :override_data_types
+  wb.add_worksheet(:name => "Override Data Type") do |sheet|
+    sheet.add_row ['dont eat my zeros!', '0088'] , :types => [nil, :string]
+  end
+end
 # Hyperlinks in worksheet
 if examples.include? :hyperlinks
   wb.add_worksheet(:name => 'hyperlinks') do |sheet|
@@ -490,7 +509,7 @@ end
 if examples.include? :fit_to_page
   wb.add_worksheet(:name => "fit to page") do |sheet|
     sheet.add_row ['this all goes on one page']
-    sheet.fit_to_page = true
+    sheet.page_setup.fit_to :width => 1, :height => 1
   end
 end
 ##```
@@ -502,7 +521,7 @@ end
 if examples.include? :hide_gridlines
   wb.add_worksheet(:name => "No Gridlines") do |sheet|
     sheet.add_row ["This", "Sheet", "Hides", "Gridlines"]
-    sheet.show_gridlines = false
+    sheet.sheet_view.show_grid_lines = false
   end
 end
 ##```
@@ -704,11 +723,6 @@ if examples.include? :shared_strings
 end
 #```
 
-#p.validate do |er|
-#puts er.inspect
-#end
-##Disabling Autowidth
-
 #```ruby
 if examples.include? :no_autowidth
   p = Axlsx::Package.new
@@ -717,11 +731,19 @@ if examples.include? :no_autowidth
   wb.add_worksheet(:name => "Manual Widths") do | sheet |
     sheet.add_row ['oh look! no autowidth']
   end
-  p.validate.each { |e| puts e.message }
   p.serialize("no-use_autowidth.xlsx")
 end
 #```
 
 
 
+if examples.include? :cached_formula
+  p = Axlsx::Package.new
+  p.use_shared_strings = true
+  wb = p.workbook
+  wb.add_worksheet(:name => "cached formula") do | sheet |
+    sheet.add_row [1, 2, '=A1+B1'], :formula_values => [nil, nil, 3]
+  end
+  p.serialize 'cached_formula.xlsx'
+end
 

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/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/styles.rb

@@ -48,6 +48,9 @@ wb.styles do |style|
   # 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|
 
@@ -55,6 +58,7 @@ wb.styles do |style|
     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

data/lib/axlsx.rb

@@ -104,6 +104,20 @@ module Axlsx
     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]
@@ -113,4 +127,18 @@ module Axlsx
     s.gsub(/_(.)/){ $1.upcase }
   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

data/lib/axlsx/drawing/bar_3D_chart.rb

@@ -21,7 +21,9 @@ module Axlsx
     # The direction of the bars in the chart
     # must be one of [:bar, :col]
     # @return [Symbol]
-    attr_reader :bar_dir
+    def bar_dir
+      @bar_dir ||= :bar
+    end
     alias :barDir :bar_dir
 
     # space between bar or column clusters, as a percentage of the bar or column width.
@@ -31,18 +33,24 @@ module Axlsx
 
     # space between bar or column clusters, as a percentage of the bar or column width.
     # @return [String]
-    attr_reader :gap_width 
+    def gap_width
+      @gap_width ||= 150
+    end
     alias :gapWidth :gap_width
-
+    
     #grouping for a column, line, or area chart.
     # must be one of  [:percentStacked, :clustered, :standard, :stacked]
     # @return [Symbol]
-    attr_reader :grouping
+    def grouping
+      @grouping ||= :clustered
+    end
 
     # The shabe of the bars or columns
     # must be one of  [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax]
     # @return [Symbol]
-    attr_reader :shape
+    def shape
+      @shape ||= :box
+    end
 
     # validation regex for gap amount percent
     GAP_AMOUNT_PERCENT = /0*(([0-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%/
@@ -65,10 +73,7 @@ module Axlsx
     # @see Chart
     # @see View3D
     def initialize(frame, options={})
-      @bar_dir = :bar
-      @grouping = :clustered
-      @shape = :box
-      @gap_width = 150
+      @vary_colors = true
       @gap_width, @gap_depth, @shape = nil, nil, nil
       @cat_ax_id = rand(8 ** 8)
       @val_ax_id = rand(8 ** 8)
@@ -124,7 +129,7 @@ module Axlsx
         str_inner << '<c:bar3DChart>'
         str_inner << '<c:barDir val="' << bar_dir.to_s << '"/>'
         str_inner << '<c:grouping val="' << grouping.to_s << '"/>'
-        str_inner << '<c:varyColors val="1"/>'
+        str_inner << '<c:varyColors val="' << vary_colors.to_s << '"/>'
         @series.each { |ser| ser.to_xml_string(str_inner) }
         @d_lbls.to_xml_string(str) if @d_lbls
         str_inner << '<c:gapWidth val="' << @gap_width.to_s << '"/>' unless @gap_width.nil?

data/lib/axlsx/drawing/chart.rb

@@ -49,6 +49,13 @@ module Axlsx
       @d_lbls ||= DLbls.new(self.class)
     end
 
+    # Indicates that colors should be varied by datum
+    # @return [Boolean]
+    attr_reader :vary_colors
+ 
+    # Configures the vary_colors options for this chart
+    # @param [Boolean] v The value to set
+    def vary_colors=(v) Axlsx::validate_boolean(v); @vary_colors = v; end
 
     # The title object for the chart.
     # @return [Title]
@@ -63,6 +70,12 @@ module Axlsx
     # @return [Boolean]
     attr_reader :show_legend
 
+    # returns a relationship object for the chart
+    # @return [Axlsx::Relationship]
+    def relationship
+      Relationship.new(CHART_R, "../#{pn}")
+    end
+
     # The index of this chart in the workbooks charts collection
     # @return [Integer]
     def index
@@ -127,7 +140,6 @@ module Axlsx
       str << '<c:style val="' << style.to_s << '"/>'
       str << '<c:chart>'
       @title.to_xml_string str
-      # do these need the c: namespace as well???
       str << '<c:autoTitleDeleted val="' << (@title == nil).to_s << '"/>'
       @view_3D.to_xml_string(str) if @view_3D
       str << '<c:floor><c:thickness val="0"/></c:floor>'

data/lib/axlsx/drawing/drawing.rb

@@ -132,6 +132,7 @@ module Axlsx
     end
 
     # The relational part name for this drawing
+    # #NOTE This should be rewritten to return an Axlsx::Relationship object.
     # @return [String]
     def rels_pn
       "#{DRAWING_RELS_PN % (index+1)}"
@@ -139,23 +140,23 @@ module Axlsx
 
     # The index of a chart, image or hyperlink object this drawing contains
     def index_of(object)
-      objects = charts + images + hyperlinks
-      objects.index(object)
+      child_objects.index(object)
+    end
+
+
+    # An ordered list of objects this drawing holds
+    # It is important that the objects are returned in the same order each time for 
+    # releationship indexing in the package
+    # @return [Array]
+    def child_objects
+      charts + images + hyperlinks
     end
 
     # The drawing's relationships.
     # @return [Relationships]
     def relationships
       r = Relationships.new
-      charts.each do |chart|
-        r << Relationship.new(CHART_R, "../#{chart.pn}")
-      end
-      images.each do |image|
-        r << Relationship.new(IMAGE_R, "../#{image.pn}")
-      end
-      hyperlinks.each do |hyperlink|
-        r << Relationship.new(HYPERLINK_R, hyperlink.href, :target_mode => :External)
-      end
+      child_objects.each { |child| r << child.relationship }
       r
     end
 

data/lib/axlsx/drawing/graphic_frame.rb

@@ -24,7 +24,12 @@ module Axlsx
 
     # The relationship id for this graphic
     # @return [String]
+    #
+    # NOTE: Discontinued. This should not be part of GraphicFrame.
+    # The drawing object maintains relationships and needs to be queried to determine the relationship id of any given graphic data child object.
+    #
     def rId
+      warn('axlsx::DEPRECIATED: GraphicFrame#rId has been depreciated. relationship id is determed by the drawing object')
       "rId#{@anchor.index+1}"
     end
 
@@ -44,7 +49,7 @@ module Axlsx
       str << '</xdr:xfrm>'
       str << '<a:graphic>'
       str << '<a:graphicData uri="' << XML_NS_C << '">'
-      str << '<c:chart xmlns:c="' << XML_NS_C << '" xmlns:r="' << XML_NS_R << '" r:id="' << rId.to_s << '"/>'
+      str << '<c:chart xmlns:c="' << XML_NS_C << '" xmlns:r="' << XML_NS_R << '" r:id="rId' << (@anchor.drawing.index_of(@chart)+1).to_s << '"/>'
       str << '</a:graphicData>'
       str << '</a:graphic>'
       str << '</xdr:graphicFrame>'

data/lib/axlsx/drawing/hyperlink.rb

@@ -83,6 +83,11 @@ module Axlsx
     # @return [String]
     attr_accessor :tooltip
 
+    # Returns a relationship object for this hyperlink
+    # @return [Axlsx::Relationship]
+    def relationship
+      Relationship.new(HYPERLINK_R, href, :target_mode => :External)
+    end
     # Serializes the object
     # @param [String] str
     # @return [String]