axlsx 1.1.1 → 1.1.2

data/README.md

@@ -16,11 +16,13 @@ Axlsx: Office Open XML Spreadsheet Generation
 
 **License**: MIT License
 
-**Latest Version**: 1.1.1
+**Latest Version**: 1.1.2
 
 **Ruby Version**: 1.8.7, 1.9.2, 1.9.3
 
-**JRuby Version**: 1.6.7
+**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**: April 18th 2012
 
@@ -283,6 +285,8 @@ wb.add_worksheet(:name => "Bar Chart") do |sheet|
   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
 ```
@@ -443,15 +447,14 @@ p.use_shared_strings = true
 p.serialize("shared_strings_example.xlsx")
 ```
 
-
 ##Disabling Autowidth
 
 ```ruby
 p = Axlsx::Package.new
 p.use_autowidth = false
 wb = p.workbook
-wb.add_worksheet(:name => "No Magick") do | sheet |
-  sheet.add_row ['oh look! no autowidth - and no magick loaded in your process']
+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")
@@ -471,6 +474,12 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem,
 
 #Change log
 ---------
+- ** April.25.12:*: 1.1.2 release
+   - Conditional Formatting completely implemented.
+   - refactoring / documentation for Style#add_style
+   - added in label rotation for chart axis labels
+   - bugfix to porperly assign style and type info to cells when only partial information is provided in the types/style option
+
 - ** April.18.12**: 1.1.1 release
    - bugfix for autowidth calculations across multiple rows
    - bugfix for dimension calculations with nil cells.
@@ -491,7 +500,7 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem,
    - Support for tables added in - Note: Pre 2011 versions of Mac office do not support this feature and will warn.
    - Support for splatter charts added
    - Major (like 7x faster!) performance updates.
-   - Gem now supports for JRuby 1.6.7, as well as expirimental support for Rubinius
+   - Gem now supports for JRuby 1.6.7, as well as experimental support for Rubinius
 
 Please see the {file:CHANGELOG.md} document for past release information.
 
@@ -515,8 +524,10 @@ Please see the {file:CHANGELOG.md} document for past release information.
 
 [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.
+
 #Copyright and License
 ----------
 
 Axlsx © 2011-2012 by [Randy Morgan](mailto:digial.ipseity@gmail.com). Axlsx is
-licensed under the MIT license. Please see the {file:LICENSE} document for more information.
+licensed under the MIT license. Please see the LICENSE document for more information.

data/examples/conditional_formatting/example_conditional_formatting.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+
+p = Axlsx::Package.new
+book = p.workbook
+
+# define your regular styles
+percent = book.styles.add_style(:format_code => "0.00%", :border => Axlsx::STYLE_THIN_BORDER)
+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)
+
+book.add_worksheet(:name => "Cell Is") do |ws|
+
+  # Generate 20 rows of data
+  ws.add_row ["Previous Year Quarterly Profits (JPY)"]
+  ws.add_row ["Quarter", "Profit", "% of Total"]
+  offset = 3
+  rows = 20
+  offset.upto(rows + offset) do |i|
+    ws.add_row ["Q#{i}", 10000*((rows/2-i) * (rows/2-i)), "=100*B#{i}/SUM(B3:B#{rows+offset})"], :style=>[nil, money, percent]
+  end
+
+# 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 })
+end
+
+book.add_worksheet(:name => "Color Scale") do |ws|
+  ws.add_row ["Previous Year Quarterly Profits (JPY)"]
+  ws.add_row ["Quarter", "Profit", "% of Total"]
+  offset = 3
+  rows = 20
+  offset.upto(rows + offset) do |i|
+    ws.add_row ["Q#{i}", 10000*((rows/2-i) * (rows/2-i)), "=100*B#{i}/SUM(B3:B#{rows+offset})"], :style=>[nil, money, percent]
+  end
+# Apply conditional formatting to range B3:B100 in the worksheet
+  color_scale = Axlsx::ColorScale.new
+  ws.add_conditional_formatting("B3:B100", { :type => :colorScale, :operator => :greaterThan, :formula => "100000", :dxfId => profitable, :priority => 1, :color_scale => color_scale })
+end
+
+
+book.add_worksheet(:name => "Data Bar") do |ws|
+  ws.add_row ["Previous Year Quarterly Profits (JPY)"]
+  ws.add_row ["Quarter", "Profit", "% of Total"]
+  offset = 3
+  rows = 20
+  offset.upto(rows + offset) do |i|
+    ws.add_row ["Q#{i}", 10000*((rows/2-i) * (rows/2-i)), "=100*B#{i}/SUM(B3:B#{rows+offset})"], :style=>[nil, money, percent]
+  end
+# Apply conditional formatting to range B3:B100 in the worksheet
+  data_bar = Axlsx::DataBar.new
+  ws.add_conditional_formatting("B3:B100", { :type => :dataBar, :dxfId => profitable, :priority => 1, :data_bar => data_bar })
+end
+
+book.add_worksheet(:name => "Icon Set") do |ws|
+  ws.add_row ["Previous Year Quarterly Profits (JPY)"]
+  ws.add_row ["Quarter", "Profit", "% of Total"]
+  offset = 3
+  rows = 20
+  offset.upto(rows + offset) do |i|
+    ws.add_row ["Q#{i}", 10000*((rows/2-i) * (rows/2-i)), "=100*B#{i}/SUM(B3:B#{rows+offset})"], :style=>[nil, money, percent]
+  end
+# Apply conditional formatting to range B3:B100 in the worksheet
+  icon_set = Axlsx::IconSet.new
+  ws.add_conditional_formatting("B3:B100", { :type => :iconSet, :dxfId => profitable, :priority => 1, :icon_set => icon_set })
+end
+
+p.serialize('example_conditional_formatting.xlsx')

data/examples/conditional_formatting/getting_barred.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+p = Axlsx::Package.new
+p.workbook do |wb|
+  # define your regular styles
+  styles = wb.styles
+  title = styles.add_style :sz => 15, :b => true, :u => true
+  default = styles.add_style :border => Axlsx::STYLE_THIN_BORDER
+  header = styles.add_style :bg_color => '00', :fg_color => 'FF', :b => true
+  money = styles.add_style :format_code => '#,###,##0', :border => Axlsx::STYLE_THIN_BORDER
+  percent = styles.add_style :num_fmt => Axlsx::NUM_FMT_PERCENT, :border => Axlsx::STYLE_THIN_BORDER
+
+  # define the style for conditional formatting - its the :dxf bit that counts!
+  profitable =  styles.add_style :fg_color => 'FF428751', :sz => 12, :type => :dxf, :b => true
+
+  wb.add_worksheet(:name => 'Data Bar Conditional Formatting') do  |ws|
+    ws.add_row ['A$$le Q1 Revenue Historical Analysis (USD)'], :style => title
+    ws.add_row
+    ws.add_row ['Quarter', 'Profit', '% of Total'], :style => header
+    ws.add_row ['Q1-2010', '15680000000', '=B4/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2011', '26740000000', '=B5/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2012', '46330000000', '=B6/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2013(est)', '72230000000', '=B7/SUM(B4:B7)'], :style => [default, money, percent]
+
+    ws.merge_cells 'A1:C1'
+
+    # Apply conditional formatting to range B4:B7 in the worksheet
+    data_bar = Axlsx::DataBar.new
+    ws.add_conditional_formatting 'B4:B7', { :type => :dataBar,
+                                             :dxfId => profitable,
+                                             :priority => 1,
+                                             :data_bar => data_bar }
+  end
+end
+p.serialize 'getting_barred.xlsx'

data/examples/conditional_formatting/hitting_the_high_notes.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+p = Axlsx::Package.new
+p.workbook do |wb|
+  # define your regular styles
+  styles = wb.styles
+  title = styles.add_style :sz => 15, :b => true, :u => true
+  default = styles.add_style :border => Axlsx::STYLE_THIN_BORDER
+  header = styles.add_style :bg_color => '00', :fg_color => 'FF', :b => true
+  money = styles.add_style :format_code => '###,###,###,##0', :border => Axlsx::STYLE_THIN_BORDER
+  percent = styles.add_style :num_fmt => Axlsx::NUM_FMT_PERCENT, :border => Axlsx::STYLE_THIN_BORDER
+
+  # define the style for conditional formatting - its the :dxf bit that counts!
+  profitable = styles.add_style :fg_color => 'FF428751', :sz => 12, :type => :dxf, :b => true
+
+  wb.add_worksheet(:name => 'The High Notes') do  |ws|
+    ws.add_row ['A$$le Q1 Revenue Historical Analysis (USD)'], :style => title
+    ws.add_row
+    ws.add_row ['Quarter', 'Profit', '% of Total'], :style => header
+    ws.add_row ['Q1-2010', '15680000000', '=B4/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2011', '26740000000', '=B5/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2012', '46330000000', '=B6/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2013(est)', '72230000000', '=B7/SUM(B4:B7)'], :style => [default, money, percent]
+
+    ws.merge_cells 'A1:C1'
+
+    # Apply conditional formatting to range B4:B7 in the worksheet
+    ws.add_conditional_formatting 'B4:B7', { :type => :cellIs,
+                                             :operator => :greaterThan,
+                                             :formula => '27000000000',
+                                             :dxfId => profitable,
+                                             :priority => 1 }
+  end
+end
+p.serialize 'the_high_notes.xlsx'

data/examples/conditional_formatting/scaled_colors.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
+p.workbook do |wb|
+  # define your regular styles
+  styles = wb.styles
+  title = styles.add_style :sz => 15, :b => true, :u => true
+  default = styles.add_style :border => Axlsx::STYLE_THIN_BORDER
+  header = styles.add_style :bg_color => '00', :fg_color => 'FF', :b => true
+  money = styles.add_style :format_code => '#,###,##0', :border => Axlsx::STYLE_THIN_BORDER
+  percent = styles.add_style :num_fmt => Axlsx::NUM_FMT_PERCENT, :border => Axlsx::STYLE_THIN_BORDER
+
+  # define the style for conditional formatting - its the :dxf bit that counts!
+  profitable = styles.add_style :fg_color => 'FF428751', :sz => 12, :type => :dxf, :b => true
+
+  wb.add_worksheet(:name => 'Scaled Colors') do  |ws|
+    ws.add_row ['A$$le Q1 Revenue Historical Analysis (USD)'], :style => title
+    ws.add_row
+    ws.add_row ['Quarter', 'Profit', '% of Total'], :style => header
+    ws.add_row ['Q1-2010', '15680000000', '=B4/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2011', '26740000000', '=B5/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2012', '46330000000', '=B6/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2013(est)', '72230000000', '=B7/SUM(B4:B7)'], :style => [default, money, percent]
+
+    ws.merge_cells 'A1:C1'
+
+    # Apply conditional formatting to range B4:B7 in the worksheet
+    color_scale = Axlsx::ColorScale.new
+    ws.add_conditional_formatting 'B4:B7', { :type => :colorScale,
+                                             :operator => :greaterThan,
+                                             :formula => '27000000000',
+                                             :dxfId => profitable,
+                                             :priority => 1,
+                                             :color_scale => color_scale }
+  end
+end
+p.serialize 'scaled_colors.xlsx'

data/examples/conditional_formatting/stop_and_go.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+p = Axlsx::Package.new
+p.workbook do |wb|
+  # define your regular styles
+  styles = wb.styles
+  title = styles.add_style :sz => 15, :b => true, :u => true
+  default = styles.add_style :border => Axlsx::STYLE_THIN_BORDER
+  header = styles.add_style :bg_color => '00', :fg_color => 'FF', :b => true
+  money = styles.add_style :format_code => '#,###,##0', :border => Axlsx::STYLE_THIN_BORDER
+  percent = styles.add_style :num_fmt => Axlsx::NUM_FMT_PERCENT, :border => Axlsx::STYLE_THIN_BORDER
+
+  # define the style for conditional formatting - its the :dxf bit that counts!
+  profitable = styles.add_style :fg_color => 'FF428751', :sz => 12, :type => :dxf, :b => true
+
+  wb.add_worksheet(:name => 'Downtown traffic') do  |ws|
+    ws.add_row ['A$$le Q1 Revenue Historical Analysis (USD)'], :style => title
+    ws.add_row
+    ws.add_row ['Quarter', 'Profit', '% of Total'], :style => header
+    ws.add_row ['Q1-2010', '15680000000', '=B4/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2011', '26740000000', '=B5/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2012', '46330000000', '=B6/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2013(est)', '72230000000', '=B7/SUM(B4:B7)'], :style => [default, money, percent]
+
+    ws.merge_cells 'A1:C1'
+
+    # Apply conditional formatting to range B3:B7 in the worksheet
+    icon_set = Axlsx::IconSet.new
+    ws.add_conditional_formatting 'B3:B7', { :type => :iconSet,
+                                             :dxfId => profitable,
+                                             :priority => 1,
+                                             :icon_set => icon_set }
+  end
+end
+p.serialize 'stop_and_go.xlsx'

data/examples/example.rb

@@ -42,7 +42,7 @@ require 'date'
 wb.styles do |s|
   date = s.add_style(:format_code => "yyyy-mm-dd", :border => Axlsx::STYLE_THIN_BORDER)
   padded = s.add_style(:format_code => "00#", :border => Axlsx::STYLE_THIN_BORDER)
-  percent = s.add_style(:format_code => "0000%", :border => Axlsx::STYLE_THIN_BORDER)
+  percent = s.add_style(:format_code => "###0%", :border => Axlsx::STYLE_THIN_BORDER)
   # wb.date1904 = true # Use the 1904 date system (Used by Excel for Mac < 2011)
   wb.add_worksheet(:name => "Formatting Data") do |sheet|
     sheet.add_row ["Custom Formatted Date", "Percent Formatted Float", "Padded Numbers"], :style => Axlsx::STYLE_THIN_BORDER
@@ -146,7 +146,9 @@ end
 
 wb.add_worksheet(:name => "Automatic cell types") do |sheet|
   sheet.add_row ["Date", "Time", "String", "Boolean", "Float", "Integer"]
-  sheet.add_row [Date.today, Time.now, "value", true, 0.1, 1]
+  date_format = wb.styles.add_style :format_code => 'YYYY-MMM-DD'
+  time_format = wb.styles.add_style :format_code => 'HH:MM:SS'
+  sheet.add_row [Date.today, Time.now, "value", true, 0.1, 1], :style => [date_format, time_format]
 end
 
 ##Merging Cells.
@@ -170,6 +172,8 @@ wb.add_worksheet(:name => "Bar Chart") do |sheet|
   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
 

data/lib/axlsx.rb

@@ -71,7 +71,7 @@ module Axlsx
     chars = []
     while index >= 26 do
       chars << ((index % 26) + 65).chr
-      index = index / 26 - 1
+      index = (index / 26).to_i - 1
     end
     chars << (index + 65).chr
     chars.reverse.join

data/lib/axlsx/drawing/axis.rb

@@ -36,6 +36,10 @@ module Axlsx
     # @return [Symbol]
     attr_reader :crosses
 
+    # specifies how the degree of label rotation
+    # @return [Integer]
+    attr_reader :label_rotation
+
     # specifies if gridlines should be shown in the chart
     # @return [Boolean]
     attr_reader :gridlines
@@ -53,6 +57,7 @@ module Axlsx
       @axId = axId
       @crossAx = crossAx
       @format_code = "General"
+      @label_rotation = 0
       @scaling = Scaling.new(:orientation=>:minMax)
       self.axPos = :b
       self.tickLblPos = :nextTo
@@ -83,6 +88,15 @@ module Axlsx
     # must be one of [:autoZero, :min, :max]
     def crosses=(v) RestrictionValidator.validate "#{self.class}.crosses", [:autoZero, :min, :max], v; @crosses = v; end
 
+    # Specify the degree of label rotation to apply to labels
+    # default true
+    def label_rotation=(v)
+      Axlsx::validate_int(v)
+      adjusted = v.to_i * 60000
+      Axlsx::validate_angle(adjusted)
+      @label_rotation = adjusted
+    end
+
 
     # Serializes the object
     # @param [String] str
@@ -105,6 +119,8 @@ module Axlsx
       str << '<c:majorTickMark val="none"/>'
       str << '<c:minorTickMark val="none"/>'
       str << '<c:tickLblPos val="' << @tickLblPos.to_s << '"/>'
+      # some potential value in implementing this in full. Very detailed!
+      str << "<c:txPr><a:bodyPr rot='#{@label_rotation}'/><a:lstStyle/><a:p><a:pPr><a:defRPr/></a:pPr><a:endParaRPr/></a:p></c:txPr>"
       str << '<c:crossAx val="' << @crossAx.to_s << '"/>'
       str << '<c:crosses val="' << @crosses.to_s << '"/>'
     end

data/lib/axlsx/stylesheet/dxf.rb

@@ -0,0 +1,79 @@
+# encoding: UTF-8
+module Axlsx
+  # The Dxf class defines an incremental formatting record for use in Styles. The recommended way to manage styles for your workbook is with Styles#add_style
+  # @see Styles#add_style
+  class Dxf
+    # The order in which the child elements is put in the XML seems to
+    # be important for Excel
+    CHILD_ELEMENTS = [:font, :numFmt, :fill, :alignment, :border, :protection]
+    #does not support extList (ExtensionList)
+
+    # The cell alignment for this style
+    # @return [CellAlignment]
+    # @see CellAlignment
+    attr_reader :alignment
+
+    # The cell protection for this style
+    # @return [CellProtection]
+    # @see CellProtection
+    attr_reader :protection
+
+    # the child NumFmt to be used to this style
+    # @return [NumFmt]
+    attr_reader :numFmt
+
+    # the child font to be used for this style
+    # @return [Font]
+    attr_reader :font
+
+    # the child fill to be used in this style
+    # @return [Fill]
+    attr_reader :fill
+
+    # the border to be used in this style
+    # @return [Border]
+    attr_reader :border
+
+    # Creates a new Xf object
+    # @option options [Border] border
+    # @option options [NumFmt] numFmt
+    # @option options [Fill] fill
+    # @option options [Font] font
+    # @option options [CellAlignment] alignment
+    # @option options [CellProtection] protection
+    def initialize(options={})
+      options.each do |o|
+        next if o[1].nil?
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+    end
+
+    # @see Dxf#alignment
+    def alignment=(v) DataTypeValidator.validate "Dxf.alignment", CellAlignment, v; @alignment = v end
+    # @see protection
+    def protection=(v) DataTypeValidator.validate "Dxf.protection", CellProtection, v; @protection = v end
+    # @see numFmt
+    def numFmt=(v) DataTypeValidator.validate "Dxf.numFmt", NumFmt, v; @numFmt = v end
+    # @see font
+    def font=(v) DataTypeValidator.validate "Dxf.font", Font, v; @font = v end
+    # @see border
+    def border=(v) DataTypeValidator.validate "Dxf.border", Border, v; @border = v end
+    # @see fill
+    def fill=(v) DataTypeValidator.validate "Dxf.fill", Fill, v; @fill = v end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<dxf>'
+      # Dxf elements have no attributes. All of the instance variables
+      # are child elements.
+      CHILD_ELEMENTS.each do |element|
+        self.send(element).to_xml_string(str) if self.send(element)
+      end
+      str << '</dxf>'
+    end
+
+  end
+
+end