axlsx 1.1.6 → 1.1.7

data/README.md

@@ -16,7 +16,7 @@ Axlsx: Office Open XML Spreadsheet Generation
 
 **License**: MIT License
 
-**Latest Version**: 1.1.6
+**Latest Version**: 1.1.7
 
 **Ruby Version**: 1.8.7, 1.9.2, 1.9.3
 
@@ -24,7 +24,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**: May 30th 2012
+**Release Date**: June 11th 2012
 
 If you are working in rails, or with active record see:
 http://github.com/randym/acts_as_xlsx
@@ -113,7 +113,16 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem,
 
 #Change log
 ---------
-- ** May.30.12**: 1.1.6 release
+- **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
@@ -124,14 +133,14 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem,
    - resolved all warnings generating from this gem.
    - improved comment relationship management for multiple comments
 
-- ** May.13.12**: 1.1.5 release
+- **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
+- **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
@@ -155,6 +164,10 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem,
 Please see the {file:CHANGELOG.md} document for past release information.
 
 #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.
 
@@ -176,7 +189,7 @@ 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.
+[janhuehne](https://github.com/janhuehne) - for working out the decoder ring and adding in cell level validation, and providing a support for window panes.
 
 #Copyright and License
 ----------

data/examples/basic_charts.rb

@@ -0,0 +1,46 @@
+$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"]
+  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'
+  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
+  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/example.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby -w -s
 # -*- coding: utf-8 -*-
-# $LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
 
 #```ruby
 require 'axlsx'
@@ -276,6 +276,8 @@ wb.add_worksheet(:name => "Line Chart") do |sheet|
     chart.end_at 10, 15
     chart.add_series :data => sheet["B1:E1"], :title => sheet["A1"]
     chart.add_series :data => sheet["B2:E2"], :title => sheet["A2"]
+    chart.catAxis.title = 'Y Axis'
+    chart.valAxis.title = 'X Axis'
   end
 end
 #```
@@ -350,6 +352,20 @@ wb.add_worksheet(:name => 'comments') do |sheet|
   sheet.add_comment :ref => 'A1', :author => 'Bob', :text => 'Yes We Can!'
 end
 
+## Frozen/Split panes
+## ``` ruby
+wb.add_worksheet(:name => 'fixed headers') do |sheet|
+  sheet.add_row(['',  (0..99).map { |i| "column header #{i}" }].flatten )
+  100.times.with_index { |index| sheet << ["row header", (0..index).to_a].flatten }
+  sheet.sheet_view.pane do |pane|
+    pane.top_left_cell = "B2"
+    pane.state = :frozen_split
+    pane.y_split = 1
+    pane.x_split = 1
+    pane.active_pane = :bottom_right
+  end
+end
+
 ##Validate and Serialize
 
 #```ruby

data/examples/sheet_view.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+
+p = Axlsx::Package.new
+ws = p.workbook.add_worksheet :name => "Sheetview - Split"
+ws.sheet_view do |vs|
+  vs.pane do |p|
+    p.active_pane = :top_right
+    p.state = :split
+    p.x_split = 11080
+    p.y_split = 5000
+    p.top_left_cell = 'C44'
+  end
+  
+  vs.add_selection(:top_left, { :active_cell => 'A2', :sqref => 'A2' })
+  vs.add_selection(:top_right, { :active_cell => 'I10', :sqref => 'I10' })
+  vs.add_selection(:bottom_left, { :active_cell => 'E55', :sqref => 'E55' })
+  vs.add_selection(:bottom_right, { :active_cell => 'I57', :sqref => 'I57' })
+end
+
+
+ws = p.workbook.add_worksheet :name => "Sheetview - Frozen"
+ws.sheet_view do |vs|
+  vs.pane do |p|
+    p.state = :frozen
+    p.x_split = 3
+    p.y_split = 4
+  end
+end
+
+
+p.serialize 'sheet_view.xlsx'

data/lib/axlsx.rb

@@ -87,8 +87,9 @@ module Axlsx
   # performs the increadible feat of changing snake_case to CamelCase
   # @param [String] s The snake case string to camelize
   # @return [String]
-  def self.camel(s="")
-    s = s.capitalize.gsub(/_(.)/){ $1.upcase }
+  def self.camel(s="", all_caps = true)
+    s = s.capitalize if all_caps
+    s.gsub(/_(.)/){ $1.upcase }
   end
 
 end

data/lib/axlsx/drawing/axis.rb

@@ -52,6 +52,9 @@ module Axlsx
     # @return [Boolean]
     attr_reader :delete
 
+    # the title for the axis. This can be a cell or a fixed string.
+    attr_reader :title
+
     # Creates an Axis object
     # @param [Integer] ax_id the id of this axis
     # @param [Integer] cross_ax the id of the perpendicular axis
@@ -67,6 +70,7 @@ module Axlsx
       @format_code = "General"
       @delete = @label_rotation = 0
       @scaling = Scaling.new(:orientation=>:minMax)
+      @title = nil
       self.ax_pos = :b
       self.tick_lbl_pos = :nextTo
       self.format_code = "General"
@@ -113,6 +117,19 @@ module Axlsx
       @label_rotation = adjusted
     end
 
+    
+    # The title object for the chart.
+    # @param [String, Cell] v
+    # @return [Title]
+    def title=(v)
+      DataTypeValidator.validate "#{self.class}.title", [String, Cell], v
+      @title ||= Title.new
+      if v.is_a?(String)
+        @title.text = v
+      elsif v.is_a?(Cell)
+        @title.cell = v
+      end
+    end
 
     # Serializes the object
     # @param [String] str
@@ -131,6 +148,7 @@ module Axlsx
         str << '</c:spPr>'
       end
       str << '</c:majorGridlines>'
+      @title.to_xml_string(str) unless @title == nil
       str << '<c:numFmt formatCode="' << @format_code << '" sourceLinked="1"/>'
       str << '<c:majorTickMark val="none"/>'
       str << '<c:minorTickMark val="none"/>'

data/lib/axlsx/drawing/cat_axis.rb

@@ -28,7 +28,7 @@ module Axlsx
 
 
     # regex for validating label offset
-    LBL_OFFSET_REGEX = /0*(([0-9])|([1-9][0-9])|([1-9][0-9][0-9])|1000)%/
+    LBL_OFFSET_REGEX = /0*(([0-9])|([1-9][0-9])|([1-9][0-9][0-9])|1000)/
 
     # Creates a new CatAxis object
     # @param [Integer] axId the id of this axis. Inherited
@@ -46,7 +46,7 @@ module Axlsx
       @tickMarkSkip = 1
       self.auto = 1
       self.lblAlgn = :ctr
-      self.lblOffset = "100%"
+      self.lblOffset = "100"
       super(axId, crossAx, options)
     end
 
@@ -77,7 +77,7 @@ module Axlsx
       super(str)
       str << '<c:auto val="' << @auto.to_s << '"/>'
       str << '<c:lblAlgn val="' << @lblAlgn.to_s << '"/>'
-      str << '<c:lblOffset val="' << @lblOffset.to_s << '"/>'
+      str << '<c:lblOffset val="' << @lblOffset.to_i.to_s << '"/>'
       str << '<c:tickLblSkip val="' << @tickLblSkip.to_s << '"/>'
       str << '<c:tickMarkSkip val="' << @tickMarkSkip.to_s << '"/>'
       str << '</c:catAx>'

data/lib/axlsx/drawing/chart.rb

@@ -44,7 +44,7 @@ module Axlsx
     # @option options [Array|String|Cell] start_at The X, Y coordinates defining the top left corner of the chart.
     # @option options [Array|String|Cell] end_at The X, Y coordinates defining the bottom right corner of the chart.
     def initialize(frame, options={})
-      @style = 2
+      @style = 18  
       @view3D = nil
       @graphic_frame=frame
       @graphic_frame.anchor.drawing.worksheet.workbook.charts << self
@@ -120,13 +120,13 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << '<?xml version="1.0" encoding="UTF-8"?>'
-      str << '<c:chartSpace xmlns:c="' << XML_NS_C << '" xmlns:a="' << XML_NS_A << '">'
+      str << '<c:chartSpace xmlns:c="' << XML_NS_C << '" xmlns:a="' << XML_NS_A << '" xmlns:r="' << XML_NS_R << '">'
       str << '<c:date1904 val="' << Axlsx::Workbook.date1904.to_s << '"/>'
       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="0"/>'
+      str << '<c:autoTitleDeleted val="' << (@title == nil).to_s << '"/>'
       @view3D.to_xml_string(str) if @view3D
       str << '<c:floor><c:thickness val="0"/></c:floor>'
       str << '<c:sideWall><c:thickness val="0"/></c:sideWall>'

data/lib/axlsx/drawing/drawing.rb

@@ -155,7 +155,6 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'
-#      str << '<xdr:wsDr xmlns:xdr="' << XML_NS_XDR << '" xmlns:a="' << XML_NS_A << '" xmlns:c="' << XML_NS_C << '">'
       str << '<xdr:wsDr xmlns:xdr="' << XML_NS_XDR << '" xmlns:a="' << XML_NS_A << '">'
 
       anchors.each { |anchor| anchor.to_xml_string(str) }

data/lib/axlsx/drawing/graphic_frame.rb

@@ -33,9 +33,9 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       # macro attribute should be optional!
-      str << '<xdr:graphicFrame macro="">'
+      str << '<xdr:graphicFrame>'
       str << '<xdr:nvGraphicFramePr>'
-      str << '<xdr:cNvPr id="2" name="' << chart.title.text << '"/>'
+      str << '<xdr:cNvPr id="' << @anchor.drawing.index.to_s << '" name="' << 'item_' << @anchor.drawing.index.to_s << '"/>'
       str << '<xdr:cNvGraphicFramePr/>'
       str << '</xdr:nvGraphicFramePr>'
       str << '<xdr:xfrm>'

data/lib/axlsx/drawing/num_data.rb

@@ -25,8 +25,8 @@ module Axlsx
     def data=(values=[])
       @tag_name = values.first.is_a?(Cell) ? :numCache : :numLit
       values.each do |value|
-        v = value.is_a?(Cell) ? value.value : value
-        @pt << NumVal.new(:v => v)
+        value = value.is_formula? ? 0 : value.value if value.is_a?(Cell)
+        @pt << NumVal.new(:v => value)
       end
     end
 

data/lib/axlsx/drawing/title.rb

@@ -46,15 +46,27 @@ module Axlsx
       str << '<c:title>'
       unless @text.empty?
         str << '<c:tx>'
-        str << '<c:strRef>'
-        str << '<c:f>' << Axlsx::cell_range([@cell]) << '</c:f>'
-        str << '<c:strCache>'
-        str << '<c:ptCount val="1"/>'
-        str << '<c:pt idx="0">'
-        str << '<c:v>' << @text << '</c:v>'
-        str << '</c:pt>'
-        str << '</c:strCache>'
-        str << '</c:strRef>'
+        if @cell.is_a?(Cell)
+          str << '<c:strRef>'
+          str << '<c:f>' << Axlsx::cell_range([@cell]) << '</c:f>'
+          str << '<c:strCache>'
+          str << '<c:ptCount val="1"/>'
+          str << '<c:pt idx="0">'
+          str << '<c:v>' << @text << '</c:v>'
+          str << '</c:pt>'
+          str << '</c:strCache>'
+          str << '</c:strRef>'
+        else
+          str << '<c:rich>'
+            str << '<a:bodyPr/>'
+            str << '<a:lstStyle/>'
+            str << '<a:p>'
+              str << '<a:r>'
+                str << '<a:t>' << @text.to_s << '</a:t>'
+              str << '</a:r>'
+            str << '</a:p>'
+          str << '</c:rich>'
+        end
         str << '</c:tx>'
       end
       str << '<c:layout/>'

data/lib/axlsx/package.rb

@@ -80,9 +80,8 @@ module Axlsx
 
     # Serialize your workbook to disk as an xlsx document.
     #
-    # @param [File] output The file you want to serialize your package to
+    # @param [String] output The name of the file you want to serialize your package to
     # @param [Boolean] confirm_valid Validate the package prior to serialization.
-    # @option options stream indicates if we should be writing to a stream or a file. True for stream, nil for file
     # @return [Boolean] False if confirm_valid and validation errors exist. True if the package was serialized
     # @note A tremendous amount of effort has gone into ensuring that you cannot create invalid xlsx documents.
     #   confirm_valid should be used in the rare case that you cannot open the serialized file.
@@ -90,10 +89,15 @@ module Axlsx
     # @example
     #   # This is how easy it is to create a valid xlsx file. Of course you might want to add a sheet or two, and maybe some data, styles and charts.
     #   # Take a look at the README for an example of how to do it!
-    #   f = File.open('test.xlsx', 'w')
-    #   Package.new.serialize(f)
     #
-    #   # You will find a file called test.xlsx
+    #   #serialize to a file
+    #   p = Axlsx::Package.new
+    #   # ......add cool stuff to your workbook......
+    #   p.serialize("example.xlsx")
+    #
+    #   # Serialize to a stream
+    #   s = p.to_stream()
+    #   File.open('example_streamed.xlsx', 'w') { |f| f.write(s.read) }
     def serialize(output, confirm_valid=false)
       return false unless !confirm_valid || self.validate.empty?
       Zip::ZipOutputStream.open(output) do |zip|

data/lib/axlsx/util/validators.rb

@@ -109,9 +109,14 @@ module Axlsx
   end
 
   # Requires that the value is an integer ranging from 10 to 400.
-  def self.validate_page_scale(v)
+  def self.validate_scale_10_400(v)
     DataTypeValidator.validate "page_scale", [Fixnum, Integer], v, lambda { |arg| arg >= 10 && arg <= 400 }
   end
+  
+  # Requires that the value is an integer ranging from 10 to 400 or 0.
+  def self.validate_scale_0_10_400(v)
+    DataTypeValidator.validate "page_scale", [Fixnum, Integer], v, lambda { |arg| arg == 0 || (arg >= 10 && arg <= 400) }
+  end
 
   # Requires that the value is one of :default, :landscape, or :portrait.
   def self.validate_page_orientation(v)
@@ -132,8 +137,6 @@ module Axlsx
   # thisMonth, lastMonth, nextMonth, thisWeek, lastWeek, nextWeek
   def self.validate_time_period_type(v)
     RestrictionValidator.validate :time_period_type, [:today, :yesterday, :tomorrow, :last7Days, :thisMonth, :lastMonth, :nextMonth, :thisWeek, :lastWeek, :nextWeek], v
-
-
   end
 
   # Requires that the value is one of the valid ST_IconSet types
@@ -238,4 +241,25 @@ module Axlsx
   def self.validate_data_validation_type(v)
     RestrictionValidator.validate :data_validation_type, [:custom, :data, :decimal, :list, :none, :textLength, :time, :whole], v
   end
-end
+  
+  # Requires that the value is a valid sheet view type.
+  # valid types must be one of normal, page_break_preview, page_layout
+  # @param [Any] v The value validated
+  def self.validate_sheet_view_type(v)
+    RestrictionValidator.validate :sheet_view_type, [:normal, :page_break_preview, :page_layout], v
+  end
+  
+  # Requires that the value is a valid active pane type.
+  # valid types must be one of bottom_left, bottom_right, top_left, top_right
+  # @param [Any] v The value validated
+  def self.validate_pane_type(v)
+    RestrictionValidator.validate :active_pane_type, [:bottom_left, :bottom_right, :top_left, :top_right], v
+  end
+  
+  # Requires that the value is a valid split state type.
+  # valid types must be one of frozen, frozen_split, split
+  # @param [Any] v The value validated
+  def self.validate_split_state_type(v)
+    RestrictionValidator.validate :split_state_type, [:frozen, :frozen_split, :split], v
+  end
+end