axlsx 1.3.3 → 1.3.4

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 CHANGELOG
 ---------
+
+- **September.30.12**: 1.3.1
+  - Improved control character handling
+  - Added stored auto filter values and date grouping items
+  - Improved support for autowidth when custom styles are applied
+  - Added support for table style info that lets you take advantage of
+    all the predefined table styles.
+  - Improved style management for fonts so they merge undefined values
+    from the initial master.
+- **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/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.2
+**Latest Version**: 1.3.4
 
 **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 5th 2012
+**Release Date**: November ??th 2012
 
 If you are working in rails, or with active record see:
 * http://github.com/randym/acts_as_xlsx
@@ -101,6 +101,9 @@ and Numbers
 
 **19. Data labels for charts as well as series color customization.
 
+**20. Support for sheet headers and footers
+
+
 Installing
 ----------
 
@@ -149,6 +152,13 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem,
 
 #Change log
 ---------
+- **November.25.12**:1.3.4
+  - Support for headers and footers for worksheets
+  - bug fix: Properly escape hyperlink urls
+  - Improvements in color_scale generation for conditional formatting
+  - 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
@@ -157,19 +167,6 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem,
   - 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
-  - Improved support for autowidth when custom styles are applied
-  - Added support for table style info that lets you take advantage of
-    all the predefined table styles.
-  - Improved style management for fonts so they merge undefined values
-    from the initial master.
-- **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
 
 Please see the {file:CHANGELOG.md} document for past release information.
 
@@ -243,6 +240,9 @@ 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
+air and our feet on the ground.
+
 #Copyright and License
 ----------
 

data/Rakefile

@@ -11,7 +11,7 @@ end
 task :gendoc do
   #puts 'yard doc generation disabled until JRuby build native extensions for redcarpet or yard removes the dependency.'
     system "yardoc"
-    #system "yard stats --list-undoc"
+    system "yard stats --list-undoc"
 end
 
 task :test do

data/examples/example.rb

@@ -7,6 +7,7 @@ require 'axlsx'
 examples = []
 examples << :basic
 examples << :custom_styles
+examples << :wrap_text
 examples << :cell_style_override
 examples << :custom_borders
 examples << :surrounding_border
@@ -22,6 +23,7 @@ examples << :auto_filter
 examples << :data_types
 examples << :hyperlinks
 examples << :number_currency_format
+examples << :venezuela_currency
 examples << :bar_chart
 examples << :chart_gridlines
 examples << :pie_chart
@@ -33,8 +35,10 @@ examples << :hide_gridlines
 examples << :repeated_header
 examples << :defined_name
 examples << :printing
+examples << :header_footer
 examples << :comments
 examples << :panes
+examples << :sheet_view
 examples << :conditional_formatting
 examples << :streaming
 examples << :shared_strings
@@ -75,7 +79,26 @@ if examples.include? :custom_styles
     end
   end
 end
-#```
+
+
+#```ruby
+# A simple example of wrapping text. Seems this may not be working in Libre Office so here is an example for me to play with.
+if examples.include? :wrap_text
+  wb.styles do |s|
+    wrap_text = s.add_style :fg_color=> "FFFFFF",
+                            :b => true,
+                            :bg_color => "004586",
+                            :sz => 12,
+                            :border => { :style => :thin, :color => "00" },
+                            :alignment => { :horizontal => :center,
+                                            :vertical => :center ,
+                                            :wrap_text => true}
+    wb.add_worksheet(:name => 'wrap text') do |sheet|
+      sheet.add_row ['Torp, White and Cronin'], :style=>wrap_text
+      sheet.column_info.first.width = 5
+    end
+  end
+end
 
 ##Styling Cell Overrides
 
@@ -128,7 +151,7 @@ if examples.include? :surrounding_border
   # LEARN IT! LIVE IT! LOVE IT!
   defaults =  { :style => :thick, :color => "000000" }
   borders = Hash.new do |hash, key|
-    hash[key] = wb.styles.add_style :border => defaults.merge( { :edges => key.to_s.split('_').map(&:to_sym) } ) 
+    hash[key] = wb.styles.add_style :border => defaults.merge( { :edges => key.to_s.split('_').map(&:to_sym) } )
   end
   top_row =  [0, borders[:top_left], borders[:top], borders[:top], borders[:top_right]]
   middle_row = [0, borders[:left], nil, nil, borders[:right]]
@@ -146,11 +169,11 @@ if examples.include? :surrounding_border
   end
 end
 
-#```ruby 
+#```ruby
 # Hacking border styles
 if examples.include? :deep_custom_borders
   wb.styles do |s|
-    top_bottom =  s.add_style :border => { :style => :thick, :color =>"FFFF0000", :edges => [:top, :bottom] }  
+    top_bottom =  s.add_style :border => { :style => :thick, :color =>"FFFF0000", :edges => [:top, :bottom] }
     border = s.borders[s.cellXfs[top_bottom].borderId]
     # edit existing border parts
     border.prs.each do |part|
@@ -326,7 +349,7 @@ if examples.include? :hyperlinks
   wb.add_worksheet(:name => 'hyperlinks') do |sheet|
     # external references
     sheet.add_row ['axlsx']
-    #sheet.add_hyperlink :location => 'https://github.com/randym/axlsx', :ref => sheet.rows.first.cells.first
+    sheet.add_hyperlink :location => 'https://github.com/randym/axlsx', :ref => sheet.rows.first.cells.first
     # internal references
     sheet.add_hyperlink :location => "'Next Sheet'!A1", :ref => 'A2', :target => :sheet
     sheet.add_row ['next sheet']
@@ -349,6 +372,15 @@ if examples.include? :number_currency_format
     sheet.add_row [1500, -122.34, 123456789, 594829], :style=> [currency, red_negative, comma, super_funk]
   end
 end
+
+## Venezuala currency
+if examples.include? :venezuela_currency
+  wb.add_worksheet(:name => 'Venezuala_currency') do |sheet|
+    number = wb.styles.add_style :format_code => '#.##0\,00'
+    sheet.add_row [2.5] , :style => [number]
+  end
+end
+
 ##Generating A Bar Chart
 
 #```ruby
@@ -481,7 +513,7 @@ if examples.include? :repeated_header
   wb.add_worksheet(:name => "repeated header") do |sheet|
     sheet.add_row %w(These Column Header Will Render On Every Printed Sheet)
     200.times { sheet.add_row %w(1 2 3 4 5 6 7 8) }
-    wb.add_defined_name("'repeated header'!$1:$1", :local_sheet_id => sheet.index, :name => '_xlnm.Print_Titles') 
+    wb.add_defined_name("'repeated header'!$1:$1", :local_sheet_id => sheet.index, :name => '_xlnm.Print_Titles')
   end
 end
 
@@ -516,7 +548,17 @@ if examples.include? :printing
 end
 #```
 
-## Add Comments to your spreadsheet 
+## Add headers and footers to a worksheet
+#``` ruby
+if examples.include? :header_footer
+  header_footer = {:different_first => false, :odd_header => '&L&F : &A&R&D &T', :odd_footer => '&C&Pof&N'}
+  wb.add_worksheet(:name => "header footer", :header_footer => header_footer) do |sheet|
+    sheet.add_row ["this sheet has a header and a footer"]
+  end
+end
+#```
+
+## Add Comments to your spreadsheet
 #``` ruby
 if examples.include? :comments
   wb.add_worksheet(:name => 'comments') do |sheet|
@@ -528,7 +570,7 @@ end
 ## Frozen/Split panes
 ## ``` ruby
 if examples.include? :panes
-  wb.add_worksheet(:name => 'fixed headers') do |sheet|
+  wb.add_worksheet(:name => 'panes') 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|
@@ -541,6 +583,33 @@ if examples.include? :panes
   end
 end
 
+if examples.include? :sheet_view
+  ws = wb.add_worksheet(:name => 'SheetView - Split')
+  ws.sheet_view do |vs|
+    vs.pane do |pane|
+      pane.active_pane = :top_right
+      pane.state = :split
+      pane.x_split = 11080
+      pane.y_split = 5000
+      pane.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 = wb.add_worksheet :name => "Sheetview - Frozen"
+  ws.sheet_view do |vs|
+    vs.pane do |pane|
+      pane.state = :frozen
+      pane.x_split = 3
+      pane.y_split = 4
+    end
+  end
+end
+
 # conditional formatting
 #
 if examples.include? :conditional_formatting
@@ -551,59 +620,61 @@ if examples.include? :conditional_formatting
   profitable = wb.styles.add_style( :fg_color=>"FF428751",
                                    :type => :dxf)
 
-  wb.add_worksheet(:name => "Conditional Cell Is") do |ws|
+  wb.add_worksheet(:name => "Conditional Cell Is") do |sheet|
 
-    # Generate 20 rows of data
-    ws.add_row ["Previous Year Quarterly Profits (JPY)"]
-    ws.add_row ["Quarter", "Profit", "% of Total"]
+    # Generate 20 rosheet of data
+    sheet.add_row ["Previous Year Quarterly Profits (JPY)"]
+    sheet.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]
+    rosheet = 20
+    offset.upto(rosheet + offset) do |i|
+      sheet.add_row ["Q#{i}", 10000*((rosheet/2-i) * (rosheet/2-i)), "=100*B#{i}/SUM(B3:B#{rosheet+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 })
+    sheet.add_conditional_formatting("B3:B100", { :type => :cellIs, :operator => :greaterThan, :formula => "100000", :dxfId => profitable, :priority => 1 })
   end
 
-  wb.add_worksheet(:name => "Conditional Color Scale") do |ws|
-    ws.add_row ["Previous Year Quarterly Profits (JPY)"]
-    ws.add_row ["Quarter", "Profit", "% of Total"]
+  wb.add_worksheet(:name => "Conditional Color Scale") do |sheet|
+    sheet.add_row ["Previous Year Quarterly Profits (JPY)"]
+    sheet.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]
+    rosheet = 20
+    offset.upto(rosheet + offset) do |i|
+      sheet.add_row ["Q#{i}", 10000*((rosheet/2-i) * (rosheet/2-i)), "=100*B#{i}/SUM(B3:B#{rosheet+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 })
+    # color scale has two_tone and three_tone class methods to setup the excel defaults (2011)
+    # alternatively, you can pass in {:type => [:min, :max, :percent], :val => [whatever], :color =>[Some RGB String] to create a customized color scale object
+
+    color_scale = Axlsx::ColorScale.three_tone
+    sheet.add_conditional_formatting("B3:B100", { :type => :colorScale, :operator => :greaterThan, :formula => "100000", :dxfId => profitable, :priority => 1, :color_scale => color_scale })
   end
 
 
-  wb.add_worksheet(:name => "Conditional Data Bar") do |ws|
-    ws.add_row ["Previous Year Quarterly Profits (JPY)"]
-    ws.add_row ["Quarter", "Profit", "% of Total"]
+  wb.add_worksheet(:name => "Conditional Data Bar") do |sheet|
+    sheet.add_row ["Previous Year Quarterly Profits (JPY)"]
+    sheet.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]
+      sheet.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 })
+    sheet.add_conditional_formatting("B3:B100", { :type => :dataBar, :dxfId => profitable, :priority => 1, :data_bar => data_bar })
   end
 
-  wb.add_worksheet(:name => "Conditional Format Icon Set") do |ws|
-    ws.add_row ["Previous Year Quarterly Profits (JPY)"]
-    ws.add_row ["Quarter", "Profit", "% of Total"]
+  wb.add_worksheet(:name => "Conditional Format Icon Set") do |sheet|
+    sheet.add_row ["Previous Year Quarterly Profits (JPY)"]
+    sheet.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]
+      sheet.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 })
+    sheet.add_conditional_formatting("B3:B100", { :type => :iconSet, :dxfId => profitable, :priority => 1, :icon_set => icon_set })
   end
 end
 

data/examples/wrap_text.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+p = Axlsx::Package.new
+p.workbook do |wb|
+  wb.styles do |s|
+    wrap_text = s.add_style :fg_color=> "FFFFFF",
+                            :b => true,
+                            :bg_color => "004586",
+                            :sz => 12,
+                            :border => { :style => :thin, :color => "00" },
+                            :alignment => { :horizontal => :center,
+                                            :vertical => :center ,
+                                            :wrap_text => true}
+    wb.add_worksheet(:name => 'wrap text') do |sheet|
+      sheet.add_row ['Torp, White and Cronin'], :style => wrap_text
+      # Forcing the column to be a bit narrow so we can see if the text wrap.
+      sheet.column_info.first.width = 5
+    end
+  end
+end
+p.serialize 'wrap_text.xlsx'

data/lib/axlsx/drawing/chart.rb

@@ -14,7 +14,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 = 18  
+      @style = 18
       @view_3D = nil
       @graphic_frame=frame
       @graphic_frame.anchor.drawing.worksheet.workbook.charts << self

data/lib/axlsx/rels/relationship.rb

@@ -55,7 +55,7 @@ module Axlsx
       h = self.instance_values
       h[:Id] = 'rId' << rId.to_s
       str << '<Relationship '
-      str << h.map { |key, value| '' << key.to_s << '="' << value.to_s << '"'}.join(' ')
+      str << h.map { |key, value| '' << key.to_s << '="' << Axlsx::coder.encode(value.to_s) << '"'}.join(' ')
       str << '/>'
     end
 

data/lib/axlsx/util/serialized_attributes.rb

@@ -21,6 +21,16 @@ module Axlsx
       def xml_attributes
         @xml_attributes
       end
+
+      # This helper registers the attributes that will be formatted as elements.
+      def serializable_element_attributes(*symbols)
+        @xml_element_attributes = symbols
+      end
+
+      # attr reader for element attributes
+      def xml_element_attributes
+        @xml_element_attributes
+      end
     end
 
     # serializes the instance values of the defining object based on the 
@@ -36,11 +46,32 @@ module Axlsx
         key_value_pairs.delete(key) unless self.class.xml_attributes.include?(key.to_sym)
       end
       key_value_pairs.merge! additional_attributes
-
       key_value_pairs.each do |key, value|
         str << "#{Axlsx.camel(key, false)}=\"#{value}\" "
       end
       str
     end
+
+
+    # serialized instance values at text nodes on a camelized element of the
+    # attribute name. You may pass in a block for evaluation against non nil
+    # values. We use an array for element attributes becuase misordering will
+    # break the xml and 1.8.7 does not support ordered hashes.
+    # @param [String] str The string instance to which serialized data is appended
+    # @param [Array] additional_attributes An array of additional attribute names.
+    # @param [Proc] block A which will be called with the value for each element.
+    # @return [String] The serialized output.
+    def serialized_element_attributes(str='', additional_attributes=[], &block)
+      attrs = self.class.xml_element_attributes + additional_attributes
+      values = instance_values
+      attrs.each do |attribute_name|
+        value = values[attribute_name.to_s]
+        next if value.nil?
+        value = yield value if block_given?
+        element_name = Axlsx.camel(attribute_name, false)
+        str << "<#{element_name}>#{value}</#{element_name}>"
+      end
+      str
+    end
   end
 end