axlsx 1.3.5 → 1.3.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5ac3fa208421a6a360082bbc4b4365cc4109e89
+  data.tar.gz: 45f0bc90cd313ae0042a63c868166177ab312184
+SHA512:
+  metadata.gz: 1c9396cf2d1f3841902f4de9787a7f793fd98795bd21a0a77af383e38c29e8428ea9b8d507d7b9b24e4a25a548ffa561a92c7f9cfb48e59e87fc87ba33a9f390
+  data.tar.gz: 7d48a79d7beb734a9f4d8abe3011df69c10a5fab90b284bbd0924742d66b70adbff793d4462248bafc682418aca7096668b2e49fecb0acb6841fd23823dd239e

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 CHANGELOG
 ---------
-
+- **November.5.12**:1.3.2
+  - MASSIVE REFACTORING
+  - Patch for apostrophes in worksheet names
+  - added sheet_by_name for workbook so you can now find your worksheets
+    by name
+  - added insert_worksheet so you can now add a worksheet to an
+    arbitrary position in the worksheets list.
+  - reduced memory consumption for package parts post serialization
 - **September.30.12**: 1.3.1
   - Improved control character handling
   - Added stored auto filter values and date grouping items
@@ -221,3 +228,4 @@ in value caches
   - Updated documentation
 
 ##October.20.11: 0.1.0 release
+

data/README.md

@@ -1,6 +1,6 @@
 Axlsx: Office Open XML Spreadsheet Generation
 ====================================
-[![Build Status](https://secure.travis-ci.org/randym/axlsx.png)](http://travis-ci.org/randym/axlsx/)
+[![Build Status](https://secure.travis-ci.org/randym/axlsx.png?branch=master)](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.
@@ -17,28 +17,30 @@ appreciation for the gem, please don't hesitate to make a donation.
 
 **Author**: Randy Morgan
 
-**Copyright**: 2011 - 2012
+**Copyright**: 2011 - 2013
 
 **License**: MIT License
 
-**Latest Version**: 1.3.5
+**Latest Version**: 1.3.6
 
-**Ruby Version**: 1.8.7, 1.9.2, 1.9.3
+**Ruby Version**: 1.8.7 (soon to be depreciated!!!), 1.9.2, 1.9.3, 2.0.0
 
 **JRuby Version**: 1.6.7 1.8 and 1.9 modes
 
 **Rubinius Version**: rubinius 2.0.0dev * lower versions may run, this gem always tests against head.
 
-**Release Date**: February 4th 2013
+**Release Date**: April 24th 2013
 
 If you are working in rails, or with active record see:
-* http://github.com/randym/acts_as_xlsx
+[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
@@ -47,6 +49,12 @@ Axlsx_Rails provides an Axlsx renderer so you can move all your spreadsheet code
 There are guides for using axlsx and acts_as_xlsx here:
 [http://axlsx.blog.randym.net](http://axlsx.blog.randym.net)
 
+If you are working with ActiveAdmin see:
+
+[activeadmin_axlsx](http://github.com/randym/activeadmin_axlsx)
+
+It provies a plugin and dsl for generating downloadable reports.
+
 The examples directory contains a number of more specific examples as
 well.
 
@@ -152,6 +160,13 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem,
 
 #Change log
 ---------
+- **April.24.13**:1.3.6
+  - Fixed LibreOffice/OpenOffice issue to properly apply colors to lines
+    in charts.
+  - Added support for specifying between/notBetween formula in an array.
+    *thanks* straydogstudio!
+  - Added standard line chart support. *thanks* scambra
+  - Fixed straydogstudio's link in the README. *thanks* nogara!
 - **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,
@@ -172,14 +187,6 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem,
   - 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
-  - added sheet_by_name for workbook so you can now find your worksheets
-    by name
-  - added insert_worksheet so you can now add a worksheet to an
-    arbitrary position in the worksheets list.
-  - reduced memory consumption for package parts post serialization
 
 Please see the {file:CHANGELOG.md} document for past release information.
 
@@ -247,7 +254,7 @@ done without the help of the people below.
 
 [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.
+[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
 
@@ -262,11 +269,13 @@ air and our feet on the ground.
 
 [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.
+[nibus](https://github.com/nibus) - For patching sheet name uniqueness.
+
+[scambra](https://github.com/scambra) - for keeping our lines in line!
 
 #Copyright and License
 ----------
 
-Axlsx © 2011-2012 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/examples/conditional_formatting/example_conditional_formatting.rb

@@ -11,8 +11,8 @@ percent = book.styles.add_style(:format_code => "0.00%", :border => Axlsx::STYLE
 money = book.styles.add_style(:format_code => '0,000', :border => Axlsx::STYLE_THIN_BORDER)
 
 # define the style for conditional formatting
-profitable = book.styles.add_style( :fg_color=>"FF428751",
-                                    :type => :dxf)
+profitable = book.styles.add_style( :fg_color => "FF428751", :type => :dxf )
+unprofitable = wb.styles.add_style( :fg_color => "FF0000", :type => :dxf )
 
 book.add_worksheet(:name => "Cell Is") do |ws|
 
@@ -27,6 +27,8 @@ book.add_worksheet(:name => "Cell Is") do |ws|
 
 # Apply conditional formatting to range B3:B100 in the worksheet
   ws.add_conditional_formatting("B3:B100", { :type => :cellIs, :operator => :greaterThan, :formula => "100000", :dxfId => profitable, :priority => 1 })
+# Apply conditional using the between operator; NOTE: supply an array to :formula for between/notBetween
+  sheet.add_conditional_formatting("C3:C100", { :type => :cellIs, :operator => :between, :formula => ["0.00%","100.00%"], :dxfId => unprofitable, :priority => 1 })
 end
 
 book.add_worksheet(:name => "Color Scale") do |ws|

data/examples/example.rb

@@ -408,7 +408,7 @@ if examples.include? :bar_chart
     sheet.add_row ["A Simple Bar Chart"]
     %w(first second third).each { |label| sheet.add_row [label, rand(24)+1] }
     sheet.add_chart(Axlsx::Bar3DChart, :start_at => "A6", :end_at => "F20") do |chart|
-      chart.add_series :data => sheet["B2:B4"], :labels => sheet["A2:A4"], :title => sheet["A1"]
+      chart.add_series :data => sheet["B2:B4"], :labels => sheet["A2:A4"], :title => sheet["A1"], :colors => ["00FF00", "0000FF"]
     end
   end
 end
@@ -423,7 +423,7 @@ if examples.include? :chart_gridlines
     sheet.add_row ["Bar Chart without gridlines"]
     %w(first second third).each { |label| sheet.add_row [label, rand(24)+1] }
     sheet.add_chart(Axlsx::Bar3DChart, :start_at => "A6", :end_at => "F20") do |chart|
-      chart.add_series :data => sheet["B2:B4"], :labels => sheet["A2:A4"]
+      chart.add_series :data => sheet["B2:B4"], :labels => sheet["A2:A4"], :colors => ["00FF00", "FF0000"]
       chart.valAxis.gridlines = false
       chart.catAxis.gridlines = false
     end
@@ -455,14 +455,23 @@ if examples.include? :line_chart
     4.times do
       sheet.add_row [ rand(24)+1, rand(24)+1]
     end
-    sheet.add_chart(Axlsx::Line3DChart, :title => "Simple Line Chart", :rotX => 30, :rotY => 20) do |chart|
+    sheet.add_chart(Axlsx::Line3DChart, :title => "Simple 3D Line Chart", :rotX => 30, :rotY => 20) do |chart|
       chart.start_at 0, 5
       chart.end_at 10, 20
-      chart.add_series :data => sheet["A3:A6"], :title => sheet["A2"]
-      chart.add_series :data => sheet["B3:B6"], :title => sheet["B2"]
+      chart.add_series :data => sheet["A3:A6"], :title => sheet["A2"], :color => "0000FF"
+      chart.add_series :data => sheet["B3:B6"], :title => sheet["B2"], :color => "FF0000"
       chart.catAxis.title = 'X Axis'
       chart.valAxis.title = 'Y Axis'
     end
+    sheet.add_chart(Axlsx::LineChart, :title => "Simple Line Chart", :rotX => 30, :rotY => 20) do |chart|
+      chart.start_at 0, 21
+      chart.end_at 10, 41
+      chart.add_series :data => sheet["A3:A6"], :title => sheet["A2"], :color => "FF0000"
+      chart.add_series :data => sheet["B3:B6"], :title => sheet["B2"], :color => "00FF00"
+      chart.catAxis.title = 'X Axis'
+      chart.valAxis.title = 'Y Axis'
+    end
+
   end
 end
 #```
@@ -479,8 +488,8 @@ if examples.include? :scatter_chart
     sheet.add_chart(Axlsx::ScatterChart, :title => "example 7: Scatter Chart") do |chart|
       chart.start_at 0, 4
       chart.end_at 10, 19
-      chart.add_series :xData => sheet["B1:E1"], :yData => sheet["B2:E2"], :title => sheet["A1"]
-      chart.add_series :xData => sheet["B3:E3"], :yData => sheet["B4:E4"], :title => sheet["A3"]
+      chart.add_series :xData => sheet["B1:E1"], :yData => sheet["B2:E2"], :title => sheet["A1"], :color => "FF0000"
+      chart.add_series :xData => sheet["B3:E3"], :yData => sheet["B4:E4"], :title => sheet["A3"], :color => "00FF00"
     end
   end
 end
@@ -583,6 +592,8 @@ if examples.include? :comments
   wb.add_worksheet(:name => 'comments') do |sheet|
     sheet.add_row ['Can we build it?']
     sheet.add_comment :ref => 'A1', :author => 'Bob', :text => 'Yes We Can!'
+    sheet.add_comment :ref => 'A2', :author => 'Bob', :text => 'Yes We Can! - but I dont think  you need to know about it!', :visible => false
+
   end
 end
 
@@ -636,8 +647,8 @@ if examples.include? :conditional_formatting
   money = wb.styles.add_style(:format_code => '0,000', :border => Axlsx::STYLE_THIN_BORDER)
 
   # define the style for conditional formatting
-  profitable = wb.styles.add_style( :fg_color=>"FF428751",
-                                   :type => :dxf)
+  profitable = wb.styles.add_style( :fg_color => "FF428751", :type => :dxf )
+  unprofitable = wb.styles.add_style( :fg_color => "FF0000", :type => :dxf )
 
   wb.add_worksheet(:name => "Conditional Cell Is") do |sheet|
 
@@ -652,6 +663,8 @@ if examples.include? :conditional_formatting
 
     # Apply conditional formatting to range B3:B100 in the worksheet
     sheet.add_conditional_formatting("B3:B100", { :type => :cellIs, :operator => :greaterThan, :formula => "100000", :dxfId => profitable, :priority => 1 })
+    # Apply conditional using the between operator; NOTE: supply an array to :formula for between/notBetween
+    sheet.add_conditional_formatting("C3:C100", { :type => :cellIs, :operator => :between, :formula => ["0.00%","100.00%"], :dxfId => unprofitable, :priority => 1 })
   end
 
   wb.add_worksheet(:name => "Conditional Color Scale") do |sheet|

data/examples/pivot_table.rb

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

data/lib/axlsx/drawing/axes.rb

@@ -0,0 +1,57 @@
+module Axlsx
+  
+  # The Axes class creates and manages axis information and
+  # serialization for charts.
+  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.
+    def initialize(options={})
+      options.each do |name, axis_class|
+        add_axis(name, axis_class)
+      end
+    end
+
+    # [] provides assiciative access to a specic axis store in an axes
+    # instance. 
+    # @return [Axis]
+    def [](name)
+      axes.assoc(name)[1]
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @param [Hash] options
+    # @option options ids
+    # If the ids option is specified only the axis identifier is
+    # 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 << '"/>' }
+      else
+        axes.each { |axis| axis[1].to_xml_string(str) }
+      end
+    end
+
+    # Adds an axis to the collection
+    # @param [Symbol] name The name of the axis
+    # @param [Axis] axis_class The axis class to generate
+    def add_axis(name, axis_class)
+      axis = axis_class.new
+      set_cross_axis(axis)
+      axes << [name, axis]
+    end
+
+    private
+
+    def axes
+      @axes ||= []
+    end
+
+    def set_cross_axis(axis)
+      axes.first[1].cross_axis = axis if axes.size == 1
+      axis.cross_axis = axes.first[1] unless axes.empty?
+    end
+  end
+end

data/lib/axlsx/drawing/axis.rb

@@ -7,17 +7,13 @@ module Axlsx
     include Axlsx::OptionsParser
 
     # Creates an Axis object
-    # @param [Integer] ax_id the id of this axis
-    # @param [Integer] cross_ax the id of the perpendicular axis
+    # @option options [Axis] cross_axis the perpendicular axis
     # @option options [Symbol] ax_pos
     # @option options [Symbol] crosses
     # @option options [Symbol] tick_lbl_pos
     # @raise [ArgumentError] If axi_id or cross_ax are not unsigned integers
-    def initialize(ax_id, cross_ax, options={})
-      Axlsx::validate_unsigned_int(ax_id)
-      Axlsx::validate_unsigned_int(cross_ax)
-      @ax_id = ax_id
-      @cross_ax = cross_ax
+    def initialize(options={})
+      @id = rand(8 ** 8)
       @format_code = "General"
       @delete = @label_rotation = 0
       @scaling = Scaling.new(:orientation=>:minMax)
@@ -37,13 +33,13 @@ module Axlsx
 
     # the id of the axis.
     # @return [Integer]
-    attr_reader :ax_id
-    alias :axID :ax_id
+    attr_reader :id
+    alias :axID :id
 
     # The perpendicular axis
     # @return [Integer]
-    attr_reader :cross_ax
-    alias :crossAx :cross_ax
+    attr_reader :cross_axis
+    alias :crossAx :cross_axis
 
     # The scaling of the axis
     # @see Scaling
@@ -94,6 +90,13 @@ module Axlsx
     def color=(color_rgb)
       @color = color_rgb
     end
+    
+    # The crossing axis for this axis
+    # @param [Axis] axis
+    def cross_axis=(axis)
+       DataTypeValidator.validate "#{self.class}.cross_axis", [Axis], axis
+       @cross_axis = axis
+    end
 
     # The position of the axis
     # must be one of [:l, :r, :t, :b]
@@ -147,7 +150,7 @@ module Axlsx
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
-      str << '<c:axId val="' << @ax_id.to_s << '"/>'
+      str << '<c:axId val="' << @id.to_s << '"/>'
       @scaling.to_xml_string str
       str << '<c:delete val="'<< @delete.to_s << '"/>'
       str << '<c:axPos val="' << @ax_pos.to_s << '"/>'
@@ -175,7 +178,7 @@ module Axlsx
       end
       # some potential value in implementing this in full. Very detailed!
       str << '<c:txPr><a:bodyPr rot="' << @label_rotation.to_s << '"/><a:lstStyle/><a:p><a:pPr><a:defRPr/></a:pPr><a:endParaRPr/></a:p></c:txPr>'
-      str << '<c:crossAx val="' << @cross_ax.to_s << '"/>'
+      str << '<c:crossAx val="' << @cross_axis.id.to_s << '"/>'
       str << '<c:crosses val="' << @crosses.to_s << '"/>'
     end
 

data/lib/axlsx/drawing/bar_3D_chart.rb

@@ -10,12 +10,16 @@ module Axlsx
 
     # the category axis
     # @return [CatAxis]
-    attr_reader :cat_axis
+    def cat_axis
+      axes[:cat_axis]
+    end
     alias :catAxis :cat_axis
 
     # the value axis
     # @return [ValAxis]
-    attr_reader :val_axis
+    def val_axis
+      axes[:val_axis]
+    end
     alias :valAxis :val_axis
 
     # The direction of the bars in the chart
@@ -75,10 +79,6 @@ module Axlsx
     def initialize(frame, options={})
       @vary_colors = true
       @gap_width, @gap_depth, @shape = nil, nil, nil
-      @cat_ax_id = rand(8 ** 8)
-      @val_ax_id = rand(8 ** 8)
-      @cat_axis = CatAxis.new(@cat_ax_id, @val_ax_id)
-      @val_axis = ValAxis.new(@val_ax_id, @cat_ax_id, :tick_lbl_pos => :low, :ax_pos => :l)
       super(frame, options)
       @series_type = BarSeries
       @view_3D = View3D.new({:r_ang_ax=>1}.merge(options))
@@ -131,17 +131,21 @@ module Axlsx
         str_inner << '<c:grouping val="' << grouping.to_s << '"/>'
         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
+        @d_lbls.to_xml_string(str_inner) if @d_lbls
         str_inner << '<c:gapWidth val="' << @gap_width.to_s << '"/>' unless @gap_width.nil?
         str_inner << '<c:gapDepth val="' << @gap_depth.to_s << '"/>' unless @gap_depth.nil?
         str_inner << '<c:shape val="' << @shape.to_s << '"/>' unless @shape.nil?
-        str_inner << '<c:axId val="' << @cat_ax_id.to_s << '"/>'
-        str_inner << '<c:axId val="' << @val_ax_id.to_s << '"/>'
-        str_inner << '<c:axId val="0"/>'
+        axes.to_xml_string(str_inner, :ids => true)
         str_inner << '</c:bar3DChart>'
-        @cat_axis.to_xml_string str_inner
-        @val_axis.to_xml_string str_inner
+        axes.to_xml_string(str_inner)
       end
     end
+
+    # A hash of axes used by this chart. Bar charts have a value and
+    # category axes specified via axex[:val_axes] and axes[:cat_axis]
+    # @return [Axes]
+    def axes
+     @axes ||= Axes.new(:val_axis => ValAxis, :cat_axis => CatAxis)
+    end
   end
 end

data/lib/axlsx/drawing/cat_axis.rb

@@ -4,23 +4,15 @@ module Axlsx
   class CatAxis < Axis
 
     # Creates a new CatAxis object
-    # @param [Integer] ax_id the id of this axis. Inherited
-    # @param [Integer] cross_ax the id of the perpendicular axis. Inherited
-    # @option options [Symbol] ax_pos. Inherited
-    # @option options [Symbol] tick_lbl_pos. Inherited
-    # @option options [Symbol] crosses. Inherited
-    # @option options [Boolean] auto
-    # @option options [Symbol] lbl_algn
-    # @option options [Integer] lbl_offset
     # @option options [Integer] tick_lbl_skip
     # @option options [Integer] tick_mark_skip
-    def initialize(ax_id, cross_ax, options={})
+    def initialize(options={})
       @tick_lbl_skip = 1
       @tick_mark_skip = 1
       self.auto = 1
       self.lbl_algn = :ctr
       self.lbl_offset = "100"
-      super(ax_id, cross_ax, options)
+      super(options)
     end
 
     # From the docs: This element specifies that this axis is a date or text axis based on the data that is used for the axis labels, not a specific choice.