axlsx 1.0.9 → 1.0.10

data/doc/top-level-namespace.html

@@ -94,9 +94,9 @@
 </div>
     
     <div id="footer">
-  Generated on Sat Nov 26 13:16:40 2011 by 
+  Generated on Wed Nov 30 08:53:53 2011 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.7.3 (ruby-1.9.3).
+  0.7.3 (ruby-1.8.7).
 </div>
 
   </body>

data/examples/example.rb

@@ -1,19 +1,20 @@
+#!/usr/bin/env ruby
 # -*- coding: utf-8 -*-
-# encoding: utf-8
      require 'rubygems'
-     require 'axlsx'
+     require 'axlsx.rb'
 
 
 #A Simple Workbook
-
+if ARGV.size == 0 || ARGV.include?("1")
       p = Axlsx::Package.new
       p.workbook.add_worksheet do |sheet|
         sheet.add_row ["First", "Second", "Third"]
         sheet.add_row [1, 2, 3]
       end
       p.serialize("example1.xlsx")
-
+end
 #Generating A Bar Chart
+if ARGV.size==0 || ARGV.include?("2")
 
      p = Axlsx::Package.new
      p.workbook.add_worksheet do |sheet|
@@ -24,8 +25,9 @@
        end
      end  
      p.serialize("example2.xlsx")
-
+end
 #Generating A Pie Chart
+if ARGV.size==0 || ARGV.include?("3")
 
      p = Axlsx::Package.new
      p.workbook.add_worksheet do |sheet|
@@ -36,9 +38,10 @@
        end
      end  
      p.serialize("example3.xlsx")
-
+end
 
 #Using Custom Styles
+if ARGV.size==0 || ARGV.include?("4")
 
      p = Axlsx::Package.new
      wb = p.workbook
@@ -49,8 +52,9 @@
        sheet.add_row [1, 2, 3], :style => Axlsx::STYLE_THIN_BORDER
      end
      p.serialize("example4.xlsx")
-
+end
 #Using Custom Formatting and date1904
+if ARGV.size==0 || ARGV.include?("5")
 
      p = Axlsx::Package.new
      wb = p.workbook
@@ -63,8 +67,9 @@
        sheet.add_row [Time.now, 0.2, 32], :style => [date, percent, padded]
      end
      p.serialize("example5.xlsx")
-
+end
 #Validation
+if ARGV.size==0 || ARGV.include?("6")
 
      p = Axlsx::Package.new
      p.workbook.add_worksheet do |sheet|
@@ -75,8 +80,9 @@
      p.validate.each do |error|
        puts error.inspect
      end
-      
+end      
 #Generating A Line Chart
+if ARGV.size==0 || ARGV.include?("7")
 
      p = Axlsx::Package.new
      p.workbook.add_worksheet do |sheet|
@@ -90,9 +96,10 @@
        end
        
      end  
-     p.serialize("example6.xlsx")
-
+     p.serialize("example7.xlsx")
+end
 #Add an Image
+if ARGV.size==0 || ARGV.include?("8")
 
      p = Axlsx::Package.new
      p.workbook.add_worksheet do |sheet|
@@ -103,10 +110,11 @@
          image.start_at 2, 2
        end
      end  
-     p.serialize("example7.xlsx")
-
+     p.serialize("example8.xlsx")
+end
 
 #Asian Language Support
+if ARGV.size==0 || ARGV.include?("9")
 
      p = Axlsx::Package.new
      p.workbook.add_worksheet do |sheet|
@@ -114,5 +122,54 @@
        sheet.add_row ["华语/華語"]
        sheet.add_row ["한국어/조선말"]
      end  
-     p.serialize("example8.xlsx")
+     p.serialize("example9.xlsx")
+end
+
+
+#Styling Columns
+if ARGV.size==0 || ARGV.include?("10")
+     p = Axlsx::Package.new
+     percent = p.workbook.styles.add_style :num_fmt => 9
+     p.workbook.add_worksheet do |sheet|
+       sheet.add_row ['col 1', 'col 2', 'col 3', 'col 4']
+       sheet.add_row [1, 2, 0.3, 4]
+       sheet.add_row [1, 2, 0.2, 4]
+       sheet.add_row [1, 2, 0.1, 4]
+     end
+     p.workbook.worksheets.first.col_style 2, percent, :row_offset=>1
+     p.serialize("example10.xlsx")
+end
+
+#Styling Rows
+if ARGV.size==0 || ARGV.include?("11")
+     p = Axlsx::Package.new
+     p.workbook.add_worksheet do |sheet|
+       sheet.add_row ['col 1', 'col 2', 'col 3', 'col 4']
+       sheet.add_row [1, 2, 0.3, 4]
+       sheet.add_row [1, 2, 0.2, 4]
+       sheet.add_row [1, 2, 0.1, 4]
+     end
+     head = p.workbook.styles.add_style :bg_color => "FF000000", :fg_color=>"FFFFFFFF"
+     percent = p.workbook.styles.add_style :num_fmt => 9
+     p.workbook.worksheets.first.col_style 2, percent, :row_offset=>1
+     p.workbook.worksheets.first.row_style 0, head
+     p.serialize("example11.xlsx")
+end
+
+#Rails 3
+      
+     #  class MyModel < ActiveRecord::Base
+     #    acts_as_axlsx
+     #  end
+     #
+     # class MyModelController <  ApplicationController
+     #
+     #   GET /posts/xlsx
+     #   def xlsx
+     #     p = Post.to_xlsx
+     #     p.serialize('posts.xlsx')
+     #     send_file 'posts.xlsx', :type=>"application/xlsx", :x_sendfile=>true
+     #   end
+
+     
 

data/lib/axlsx/package.rb

@@ -15,7 +15,12 @@ module Axlsx
       @core.creator = options[:author] || @core.creator
       yield self if block_given?
     end
-    
+
+    # Accepts a ruport table for serialization to xlsx
+    # @param [Table] table a ruport Table object
+    def ruport_table(table)
+      puts table
+    end
 
     # The workbook this package will serialize or validate.
     # @return [Workbook] If no workbook instance has been assigned with this package a new Workbook instance is returned.
@@ -31,6 +36,8 @@ module Axlsx
     #     wb = Package.new().workbook = Workbook.new
     def workbook
       @workbook || @workbook = Workbook.new
+      yield @workbook if block_given?
+      @workbook
     end
 
     # @see workbook

data/lib/axlsx/stylesheet/styles.rb

@@ -258,7 +258,7 @@ module Axlsx
       @numFmts.lock
 
       @fonts = SimpleTypedList.new Font
-      @fonts << Font.new(:name => "Arial", :sz => 11, :family=>1)
+      @fonts << Font.new(:name => "Arial", :sz => 11, :family=>1, :numFmt=>"0")
       @fonts.lock
 
       @fills = SimpleTypedList.new Fill

data/lib/axlsx/util/simple_typed_list.rb

@@ -38,6 +38,10 @@ module Axlsx
       @locked_at = @list.size
       self
     end
+    
+    def to_ary
+      @list
+    end
 
     # Unlock the list
     # @return [self]
@@ -152,4 +156,5 @@ module Axlsx
     end
   end
 
+
 end

data/lib/axlsx/version.rb

@@ -1,4 +1,4 @@
 module Axlsx
   # version
-  VERSION="1.0.9"
+  VERSION="1.0.10"
 end

data/lib/axlsx/workbook/workbook.rb

@@ -63,8 +63,10 @@ require 'axlsx/workbook/worksheet/worksheet.rb'
     # @see Style#add_style
     # @see Style
     # @return [Styles]
-    attr_reader :styles
-
+    def styles
+      yield @styles if block_given?
+      @styles
+    end
 
 
     # Indicates if the epoc date for serialization should be 1904. If false, 1900 is used.

data/lib/axlsx/workbook/worksheet/cell.rb

@@ -167,10 +167,14 @@ module Axlsx
     #   About Time - Time in OOXML is *different* from what you might expect. The history as to why is interesting,  but you can safely assume that if you are generating docs on a mac, you will want to specify Workbook.1904 as true when using time typed values.
     # @see Axlsx#date1904
     def cast_value(v)
-      if @type == :time && v.is_a?(Time)
-        #todo consider a time parsing method to convert strings to time
-        epoc = Workbook.date1904 ? Time.local(1904,1,1,0,0,0,0,v.zone) : Time.local(1900,1,1,0,0,0,0,v.zone)
-        ((v - epoc) /60.0/60.0/24.0).to_f
+      if (@type == :time && v.is_a?(Time)) || (@type == :time && v.respond_to?(:to_time))
+        v = v.respond_to?(:to_time) ? v.to_time : v
+        # Using hardcoded offsets here as some operating systems will not except a 'negative' offset from the ruby epoc.
+        # (1970)
+        epoc1900 = -2209021200 #Time.local(1900, 1, 1) 
+        epoc1904 = -2082877200 #Time.local(1904, 1, 1) 
+        epoc = Workbook.date1904 ? epoc1904 : epoc1900
+        ((v.localtime.to_f - epoc) /60.0/60.0/24.0).to_f
       elsif @type == :float
         v.to_f
       elsif @type == :integer
@@ -178,15 +182,6 @@ module Axlsx
       else
         @type = :string
         v.to_s
-        # curious as to why this would be the cells responsibility
-        # convert your values before passing them in wankers! CGI.unescapeHTML(v.to_s).to_xs
-        # to revert, load this once when the gem is loaded.
-        # unless String.method_defined? :to_xs
-        #   require 'fast_xs' #dep
-        #   class String
-        #     alias_method :to_xs, :fast_xs
-        #   end
-        # end
       end
     end    
   end

data/lib/axlsx/workbook/worksheet/row.rb

@@ -54,6 +54,20 @@ module Axlsx
       c
     end
     
+    # sets the style for every cell in this row
+    def style=(style)
+      cells.each_with_index do | cell, index |
+        s = style.is_a?(Array) ? style[index] : style
+        cell.style = s
+      end
+    end
+
+    # returns the cells in this row as an array
+    # This lets us transpose the rows into columns 
+    # @return [Array]
+    def to_ary
+      @cells.to_ary
+    end
 
     private
 
@@ -66,6 +80,7 @@ module Axlsx
       worksheet.send(:update_auto_fit_data, self.cells)
     end
 
+
     # Converts values, types, and style options into cells and associates them with this row.
     # A new cell is created for each item in the values array.
     # If value option is defined and is a symbol it is applied to all the cells created.

data/lib/axlsx/workbook/worksheet/worksheet.rb

@@ -39,6 +39,7 @@ module Axlsx
       @auto_fit_data = []
       self.name = options[:name] || "Sheet" + (index+1).to_s
       @magick_draw = Magick::Draw.new
+      @cols = SimpleTypedList.new Cell
     end
 
     # The name of the worksheet
@@ -89,6 +90,48 @@ module Axlsx
       @rows.last
     end
 
+    # Set the style for cells in a specific row
+    # @param [Integer] index or range of indexes in the table
+    # @param [Integer] the cellXfs index
+    # @option options [Integer] col_offset only cells after this column will be updated.
+    # @note You can also specify the style in the add_row call
+    # @see Worksheet#add_row
+    # @see README.md for an example
+    def row_style(index, style, options={})
+      offset = options.delete(:col_offset) || 0
+      rs = @rows[index]
+      if rs.is_a?(Array)
+        rs.each { |r| r.cells[(offset..-1)].each { |c| c.style = style } }
+      else
+        rs.cells[(offset..-1)].each { |c| c.style = style }
+      end
+    end
+
+    # returns the sheet data as columnw
+    def cols
+      @rows.transpose
+    end
+
+
+    # Set the style for cells in a specific column
+    # @param [Integer] index the index of the column
+    # @param [Integer] the cellXfs index
+    # @option options [Integer] row_offset only cells after this column will be updated.
+    # @note You can also specify the style for specific columns in the call to add_row by using an array for the :styles option
+    # @see Worksheet#add_row
+    # @see README.md for an example
+    def col_style(index, style, options={})
+      offset = options.delete(:row_offset) || 0
+      @rows[(offset..-1)].each do |r| 
+        cells = r.cells[index]
+        if cells.is_a?(Array)
+          cells.each { |c| c.style = style }
+        else
+          cells.style = style
+        end
+      end
+    end
+    
     # Adds a chart to this worksheets drawing. This is the recommended way to create charts for your worksheet. This method wraps the complexity of dealing with ooxml drawing, anchors, markers graphic frames chart objects and all the other dirty details. 
     # @param [Class] chart_type
     # @option options [Array] start_at
@@ -183,7 +226,7 @@ module Axlsx
     #  From ECMA docs
     #   Column width measured as the number of characters of the maximum digit width of the numbers 0 .. 9 as 
     #   rendered in the normal style's font. There are 4 pixels of margin padding (two on each side), plus 1 pixel padding for the gridlines.
-    #   width = Truncate([!{Number of Characters} * !{Maximum Digit Width} + !{5 pixel padding}]/!{Maximum Digit Width}*256)/256
+    #   width = Truncate([!{Number of Characters} * !{Maximum Digit Width} + !{5 pixel padding}]/{Maximum Digit Width}*256)/256
     # @return [Float]
     # @param [Hash] A hash of auto_fit_data 
     def auto_width(col)

data/lib/axlsx.rb

@@ -16,19 +16,17 @@ require 'axlsx/drawing/drawing.rb'
 require 'axlsx/workbook/workbook.rb'
 require 'axlsx/package.rb'
 
-
-
 #required gems
-require 'Nokogiri'
+require 'nokogiri'
 require 'active_support/core_ext/object/instance_variables'
 require 'active_support/inflector'
-require 'rmagick'
+require 'RMagick'
 require 'zip/zip'
 
 #core dependencies
 require 'bigdecimal'
 require 'time'
-require 'CGI'
+
 
 # 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

data/test/rels/tc_relationships.rb

@@ -2,14 +2,10 @@ require 'test/unit'
 require 'axlsx.rb'
 
 class TestRelationships < Test::Unit::TestCase
-  def setup    
-    @rels = Axlsx::Relationships.new
-  end
-  
-  def teardown    
-  end  
+
 
   def test_valid_document
+    @rels = Axlsx::Relationships.new
     schema = Nokogiri::XML::Schema(File.open(Axlsx::RELS_XSD))
     doc = Nokogiri::XML(@rels.to_xml)
     errors = []

data/test/workbook/worksheet/tc_row.rb

@@ -14,6 +14,12 @@ class TestRow < Test::Unit::TestCase
     assert_equal(@row.worksheet, @ws, "has a reference to the worksheet")
   end
 
+  def test_style
+    r = @ws.add_row([1,2,3,4,5])
+    r.style=1
+    r.cells.each { |c| assert_equal(c.style,1) }    
+  end
+
   def test_index
     assert_equal(@row.index, @row.worksheet.rows.index(@row))
   end

data/test/workbook/worksheet/tc_worksheet.rb

@@ -46,6 +46,42 @@ class TestWorksheet < Test::Unit::TestCase
     assert @ws.drawing.is_a? Axlsx::Drawing
   end
 
+  def test_col_style
+    @ws.add_row [1,2,3,4]
+    @ws.add_row [1,2,3,4]
+    @ws.add_row [1,2,3,4]
+    @ws.add_row [1,2,3,4]
+    @ws.col_style( (1..2), 1, :row_offset=>1)
+    @ws.rows[(1..-1)].each do | r | 
+      assert_equal(r.cells[1].style, 1)
+      assert_equal(r.cells[2].style, 1)
+    end
+    assert_equal(@ws.rows.first.cells[1].style, 0)
+    assert_equal(@ws.rows.first.cells[0].style, 0)
+  end
+
+  def test_cols
+    @ws.add_row [1,2,3,4]
+    @ws.add_row [1,2,3,4]
+    @ws.add_row [1,2,3,4]
+    @ws.add_row [1,2,3,4]
+    c = @ws.cols[1]
+    assert_equal(c.size, 4)    
+    assert_equal(c[0].value, 2)
+  end
+
+  def test_row_style
+    @ws.add_row [1,2,3,4]
+    @ws.add_row [1,2,3,4]
+    @ws.add_row [1,2,3,4]
+    @ws.add_row [1,2,3,4]
+    @ws.row_style 1, 1, :col_offset=>1
+    @ws.rows[1].cells[(1..-1)].each do | c | 
+      assert_equal(c.style, 1)
+    end
+    assert_equal(@ws.rows[1].cells[0].style, 0)
+    assert_equal(@ws.rows[2].cells[1].style, 0)
+  end
   
   def test_to_xml
     schema = Nokogiri::XML::Schema(File.open(Axlsx::SML_XSD))