axlsx 1.1.8 → 1.2.0

data/.yardopts

@@ -1,5 +1,8 @@
 --protected
 --no-private
 --title "AXLSX"
---files LICENSE
---files CHANGELOG.md
+--readme README.md
+--markup markdown
+--markup-provider kramdown
+--files CHANGELOG.md, LICENSE
+--list-undoc

data/CHANGELOG.md

@@ -1,5 +1,44 @@
 CHANGELOG
 ---------
+- **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
+   - test coverage now back up to 100%
+   - bugfix for merge cell sorting algorithm
+   - added fit_to method for page_setup to simplify managing witdh/height
+   - added ph (phonetics) and s (style) attributes for row.
+   - resolved all warnings generating from this gem.
+   - improved comment relationship management for multiple comments
+
+- **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
+   - MOAR examples
+   - added outline level for rows and columns
+   - rebuild of numeric and axis data sources for charts
+   - added delete to axis
+   - added tick and label mark skipping for cat axis in charts
+   - bugfix for table headers method
+   - sane(er) defaults for chart positioning
+   - bugfix in val_axis_data to properly serialize value axis data. Excel does not mind as it reads from the sheet, but nokogiri has a fit if the elements are empty.
+   - Added support for specifying the color of data series in charts.
+   - bugfix using add_cell on row mismanaged calls to update_column_info.
+
+- ** April.25.12:**: 1.1.3 release
+   - Primarily because I am stupid.....Updates to readme to properly report version, add in missing docs and restructure example directory.
+
+- ** 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 properly 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.

data/README.md

@@ -17,7 +17,7 @@ Axlsx: Office Open XML Spreadsheet Generation
 
 **License**: MIT License
 
-**Latest Version**: 1.1.8
+**Latest Version**: 1.2.0
 
 **Ruby Version**: 1.8.7, 1.9.2, 1.9.3
 
@@ -25,13 +25,23 @@ Axlsx: Office Open XML Spreadsheet Generation
 
 **Rubinius Version**: rubinius 2.0.0dev * lower versions may run, this gem always tests against head.
 
-**Release Date**: July 14th 2012
+**Release Date**: August 5th 2012
 
 If you are working in rails, or with active record see:
-http://github.com/randym/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
+Axlsx_Rails provides an Axlsx renderer so you can move all your spreadsheet code from your controller into view files. Partials are supported so you can organize any code into reusable chunks (e.g. cover sheets, common styling, etc.) You can use it with acts_as_xlsx, placing the to_xlsx call in a view and add ':package => xlsx_package' to the parameter list. Now you can keep your controllers thin!
 
 There are guides for using axlsx and acts_as_xlsx here:
-[http://axlsx.blogspot.com](http://axlsx.blogspot.com)
+[http://axlsx.blog.randym.net](http://axlsx.blog.randym.net)
 
 The examples directory contains a number of more specific examples as
 well.
@@ -80,9 +90,13 @@ cell level input data validation.
 
 **16. Support for password and non password based sheet protection.
 
-**17. First stage interoperability support for GoogleDocs, LibraOffice,
+**17. First stage interoperability support for GoogleDocs, LibreOffice,
 and Numbers
 
+**18. Support for defined names, which gives you repeated header rows for printing.
+
+**19. Data labels for charts as well as series color customization.
+
 Installing
 ----------
 
@@ -95,7 +109,23 @@ To install Axlsx, use the following command:
 
 The example listing is getting overly large to maintain here.
 If you are using Yard, you will be able to see the examples in line below.
-If not, please refer to the Please see the [examples](https://github.com/randym/axlsx/tree/master/examples/example.rb) here.
+
+Here's a teaser that kicks about 2% of what the gem can do.
+
+```ruby
+Axlsx::Package.new do |p|
+  p.workbook.add_worksheet(:name => "Pie Chart") do |sheet|
+    sheet.add_row ["Simple Pie Chart"]
+    %w(first second third).each { |label| sheet.add_row [label, rand(24)+1] }
+    sheet.add_chart(Axlsx::Pie3DChart, :start_at => [0,5], :end_at => [10, 20], :title => "example 3: Pie Chart") do |chart|
+      chart.add_series :data => sheet["B2:B4"], :labels => sheet["A2:A4"],  :colors => ['FF0000', '00FF00', '0000FF']
+    end
+  end
+  p.serialize('simple.xlsx')
+end
+```
+
+Please see the [examples](https://github.com/randym/axlsx/tree/master/examples/example.rb) for more.
 
 {include:file:examples/example.rb}
 
@@ -115,6 +145,16 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem,
 
 #Change log
 ---------
+- **August.5.12**: 1.2.0
+   - rebuilt worksheet serialization to clean up the code base a bit.
+   - added data labels for charts
+   - added table header printing for each sheet via defined_name. This
+     means that when you print your worksheet, the header rows show for every page
+- **July.??.12**: 1.1.9 release
+   - lots of code clean up for worksheet
+   - added in data labels for pie charts, line charts and bar charts.
+   - bugfix chard with data in a sheet that has a space in the name are
+     now auto updating formula based values
 - **July.14.12**: 1.1.8 release
    - added html entity encoding for sheet names. This allows you to use
      characters like '<' and '&' in your sheet names.
@@ -133,45 +173,6 @@ in value caches
      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
-   - test coverage now back up to 100%
-   - bugfix for merge cell sorting algorithm
-   - added fit_to method for page_setup to simplify managing witdh/height
-   - added ph (phonetics) and s (style) attributes for row.
-   - resolved all warnings generating from this gem.
-   - improved comment relationship management for multiple comments
-
-- **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
-   - MOAR examples
-   - added outline level for rows and columns
-   - rebuild of numeric and axis data sources for charts
-   - added delete to axis
-   - added tick and label mark skipping for cat axis in charts
-   - bugfix for table headers method
-   - sane(er) defaults for chart positioning
-   - bugfix in val_axis_data to properly serialize value axis data. Excel does not mind as it reads from the sheet, but nokogiri has a fit if the elements are empty.
-   - Added support for specifying the color of data series in charts.
-   - bugfix using add_cell on row mismanaged calls to update_column_info.
-
-- ** April.25.12:**: 1.1.3 release
-   - Primarily because I am stupid.....Updates to readme to properly report version, add in missing docs and restructure example directory.
-
-- ** 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 properly assign style and type info to cells when only partial information is provided in the types/style option
-
 Please see the {file:CHANGELOG.md} document for past release information.
 
 # Known interoperability issues.
@@ -190,7 +191,6 @@ related to themes, which axlsx does not implement at this time.
 2. Google Docs
    - Images are known to not work with google docs
    - border colors do not work
-   - Charts, for the most part, do not work. Google docs has some specific requirements about how the worksheet is set up to create a chart. 
 
 3. Numbers
    - you must set 'use_shared_strings' to true
@@ -227,6 +227,8 @@ 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.
+
 #Copyright and License
 ----------
 

data/Rakefile

@@ -9,9 +9,9 @@ task :benchmark do
 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"
+  #puts 'yard doc generation disabled until JRuby build native extensions for redcarpet or yard removes the dependency.'
+    system "yardoc"
+    system "yard stats --list-undoc"
 end
 
 task :test do

data/examples/basic_charts.rb

@@ -9,6 +9,10 @@ wb.add_worksheet(:name => "Pie Chart") do |sheet|
   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"]
+    chart.d_lbls.show_val = true
+    chart.d_lbls.show_percent = true
+    chart.d_lbls.d_lbl_pos = :outEnd
+    chart.d_lbls.show_leader_lines = true
   end
 end
 
@@ -18,6 +22,8 @@ end
   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'
+    chart.d_lbls.show_val = true
+    chart.d_lbls.show_cat_name = true
   end
  end
 
@@ -30,6 +36,8 @@ end
     chart.add_series :data => sheet["A3:C3"], :labels => sheet["A2:C2"], :title => sheet["A1"]
     chart.valAxis.label_rotation = -45
     chart.catAxis.label_rotation = 45
+    chart.d_lbls.d_lbl_pos = :outEnd
+    chart.d_lbls.show_val = true
   end
  end
 

data/examples/example.rb

@@ -238,7 +238,7 @@ wb.add_worksheet(:name => "Pie Chart") do |sheet|
   sheet.add_row ["Simple Pie Chart"]
   %w(first second third).each { |label| sheet.add_row [label, rand(24)+1] }
   sheet.add_chart(Axlsx::Pie3DChart, :start_at => [0,5], :end_at => [10, 20], :title => "example 3: Pie Chart") 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 => ['FF0000', '00FF00', '0000FF']
   end
 end
 #```
@@ -314,6 +314,12 @@ wb.add_worksheet(:name => "No Gridlines") do |sheet|
 end
 ##```
 
+#```ruby
+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') 
+end
 
 # Sheet Protection and excluding cells from locking.
 unlocked = wb.styles.add_style :locked => false

data/examples/scraping_html.rb

@@ -0,0 +1,91 @@
+    require 'rubygems'
+    require 'nokogiri'
+    require 'open-uri'
+    require 'axlsx'
+
+    class Scraper
+
+       def initialize(url, selector)
+         @url = url
+         @selector = selector
+       end
+
+       def hooks
+         @hooks ||= {}
+       end
+
+       def add_hook(clue, p_roc)
+         hooks[clue] = p_roc
+       end
+
+       def export(file_name)
+         Scraper.clues.each do |clue|
+           if detail = parse_clue(clue)
+             output << [clue, detail.pop]
+             detail.each { |datum| output << ['', datum] }
+           end
+         end
+         serialize(file_name)
+       end
+
+       private
+
+       def self.clues
+         @clues ||= ['Operating system', 'Processors', 'Chipset', 'Memory type', 'Hard drive', 'Graphics',
+                     'Ports', 'Webcam', 'Pointing device', 'Keyboard', 'Network interface', 'Chipset', 'Wireless',
+                     'Power supply type', 'Energy efficiency', 'Weight', 'Minimum dimensions (W x D x H)',
+                     'Warranty', 'Software included', 'Product color']
+       end
+
+       def doc
+         @doc ||= begin 
+                    Nokogiri::HTML(open(@url))
+                  rescue
+                    raise ArgumentError, 'Invalid URL - Nothing to parse'
+                  end
+       end
+
+       def output
+         @output ||= []
+       end
+
+       def selector_for_clue(clue)
+         @selector % clue
+       end
+
+       def parse_clue(clue)
+         if element = doc.at(selector_for_clue(clue))
+           call_hook(clue, element) || element.inner_html.split('<br>').each(&:strip)
+         end
+       end
+
+       def call_hook(clue, element)
+         if hooks[clue].is_a? Proc
+            value = hooks[clue].call(element)
+            value.is_a?(Array) ? value : [value]
+         end
+       end
+
+       def package
+         @package ||= Axlsx::Package.new
+       end
+
+       def serialize(file_name)
+         package.workbook.add_worksheet do |sheet|
+           output.each { |datum| sheet.add_row datum }
+         end
+         package.serialize(file_name)
+       end
+    end
+
+    scraper = Scraper.new("http://h10010.www1.hp.com/wwpc/ie/en/ho/WF06b/321957-321957-3329742-89318-89318-5186820-5231694.html?dnr=1", "//td[text()='%s']/following-sibling::td")
+
+    # define a custom action to take against any elements found.
+    os_parse = Proc.new do |element|
+      element.inner_html.split('<br>').each(&:strip!).each(&:upcase!)
+    end
+
+    scraper.add_hook('Operating system', os_parse)
+
+    scraper.export('foo.xlsx')
+

data/lib/axlsx.rb

@@ -39,13 +39,21 @@ end
 
 # xlsx generation with charts, images, automated column width, customizable styles and full schema validation. Axlsx excels at helping you generate beautiful Office Open XML Spreadsheet documents without having to understand the entire ECMA specification. Check out the README for some examples of how easy it is. Best of all, you can validate your xlsx file before serialization so you know for sure that anything generated is going to load on your client's machine.
 module Axlsx
+
   # determines the cell range for the items provided
-  def self.cell_range(items)
-    return "" unless items.first.is_a? Cell
-    ref = "'#{items.first.row.worksheet.name}'!" +
-      "#{items.first.r_abs}"
-    ref += ":#{items.last.r_abs}" if items.size > 1
-    ref
+  def self.cell_range(cells, absolute=true)
+    return "" unless cells.first.is_a? Cell
+    sort_cells(cells)
+    reference = "#{cells.first.reference(absolute)}:#{cells.last.reference(absolute)}"
+    absolute ? "'#{cells.first.row.worksheet.name}'!#{reference}" : reference
+  end
+
+  # sorts the array of cells provided to start from the minimum x,y to
+  # the maximum x.y#
+  # @param [Array] cells
+  # @return [Array]
+  def self.sort_cells(cells)
+    cells.sort { |x, y| [x.index, x.row.index] <=> [y.index, y.row.index] }
   end
 
   #global reference html entity encoding
@@ -60,9 +68,7 @@ module Axlsx
     v = name[/[A-Z]+/].reverse.chars.reduce({:base=>1, :i=>0}) do  |val, c|
       val[:i] += ((c.bytes.first - 64) * val[:base]); val[:base] *= 26; val
     end
-
     [v[:i]-1, ((name[/[1-9][0-9]*/]).to_i)-1]
-
   end
 
   # converts the column index into alphabetical values.

data/lib/axlsx/drawing/bar_3D_chart.rb

@@ -77,6 +77,7 @@ module Axlsx
       super(frame, options)
       @series_type = BarSeries
       @view_3D = View3D.new({:r_ang_ax=>1}.merge(options))
+      @d_lbls = nil
     end
 
     # The direction of the bars in the chart
@@ -125,14 +126,7 @@ module Axlsx
         str_inner << '<c:grouping val="' << grouping.to_s << '"/>'
         str_inner << '<c:varyColors val="1"/>'
         @series.each { |ser| ser.to_xml_string(str_inner) }
-        str_inner << '<c:dLbls>'
-        str_inner << '<c:showLegendKey val="0"/>'
-        str_inner << '<c:showVal val="0"/>'
-        str_inner << '<c:showCatName val="0"/>'
-        str_inner << '<c:showSerName val="0"/>'
-        str_inner << '<c:showPercent val="0"/>'
-        str_inner << '<c:showBubbleSize val="0"/>'
-        str_inner << '</c:dLbls>'
+        @d_lbls.to_xml_string(str) 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?

data/lib/axlsx/drawing/chart.rb

@@ -46,7 +46,10 @@ module Axlsx
     attr_reader :series_type
 
     #TODO data labels!
-    #attr_reader :dLabls
+    def d_lbls
+      @d_lbls ||= DLbls.new(self.class)
+    end
+
 
     # The title object for the chart.
     # @return [Title]
@@ -154,16 +157,32 @@ module Axlsx
       str << '</c:chartSpace>'
     end
 
-    # This is a short cut method to set the start anchor position
+    # This is a short cut method to set the anchor start marker position
     # If you need finer granularity in positioning use
-    # graphic_frame.anchor.from.colOff / rowOff
-    # @param [Integer] x The column
+    #
+    # This helper method acceps a fairly wide range of inputs exampled
+    # below
+    #
+    # @example
+    #
+    #      start_at 0, 5 # The anchor start marker is set to 6th row of
+    #      the first column
+    #
+    #      start_at [0, 5] # The anchor start marker is set to start on the 6th row
+    #      of the first column
+    #
+    #      start_at "C1" # The anchor start marker is set to start on the first row
+    #      of the third column
+    #
+    #      start_at sheet.rows.first.cells.last # The anchor start
+    #      marker is set to the location of a specific cell.
+    #
+    # @param [Array|String|Cell] x the column, coordinates, string
+    # reference or cell to use in setting the start marker position.
     # @param [Integer] y The row
     # @return [Marker]
     def start_at(x=0, y=0)
-      x, y = *parse_coord_args(x, y)
-      @graphic_frame.anchor.from.col = x
-      @graphic_frame.anchor.from.row = y
+      @graphic_frame.anchor.start_at(x, y)
     end
 
     # This is a short cut method to set the end anchor position
@@ -172,27 +191,12 @@ module Axlsx
     # @param [Integer] x The column - default 10
     # @param [Integer] y The row - default 10
     # @return [Marker]
+    # @see start_at
     def end_at(x=10, y=10)
-      x, y = *parse_coord_args(x, y)
-      @graphic_frame.anchor.to.col = x
-      @graphic_frame.anchor.to.row = y
-    end
-
-    private
-
-    def parse_coord_args(x, y=0)
-      if x.is_a?(String)
-        x, y = *Axlsx::name_to_indices(x)
-      end
-      if x.is_a?(Cell)
-        x, y = *x.pos
-      end
-      if x.is_a?(Array)
-        x, y = *x
-      end
-      [x, y]
+      @graphic_frame.anchor.end_at(x, y)
     end
 
+    # sets the view_3D object for the chart
     def view_3D=(v) DataTypeValidator.validate "#{self.class}.view_3D", View3D, v; @view_3D = v; end
     alias :view3D= :view_3D=