al-to_xls 0.2.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ary Djmal, Enrique García, Francisco Juan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,64 @@
+= to_xls gem
+
+This gem transform an Array or Hash into a excel file using the spreadsheet gem.
+
+== Usage
+
+  @users = User.all
+
+  @users.to_xls
+  @users.to_xls(:headers => false)
+  @users.to_xls(:columns => [:name, :role])
+  @users.to_xls(:columns => [:name, {:company => [:name, :address]}])
+  @users.to_xls(:columns => [:name, {:company => [:name, :address]}], :headers => [:name, :company, :address])
+
+When invoked on a Hash each value is output to a separate sheet named after the corresponding key. Options for each sheet can be specified using key/values in the options hash.
+
+	{ :users => @users, :posts => @posts }.to_xls
+  { :users => @users, :posts => @posts }.to_xls(:users => { :columns => [:name, :role] }, :posts => { :headers => [:title, :content] })
+
+In order to send a file from the controller, you can save it on your server first:
+
+  @users.to_xls.write '/path/to/file/users.xls'
+  send_file '/path/to/file/users.xls'
+
+Alternatively you can use the method to_xls_data and send_data
+
+  send_data @users.to_xls_data, :filename => 'users.xls'
+    
+The method to_xls_data accepts the same parameters as to_xls.
+
+== Requirements
+
+In config/initializers/mime_types.rb register the custom mime type.
+
+  Mime::Type.register "application/vnd.ms-excel", :xls  
+
+== How to use
+
+In the controller where you want to export to excel, add the format.xls line.
+
+  class UserController < ApplicationController
+
+    def index
+      @users = User.all
+
+      respond_to do |format|
+        format.html
+        format.xml { render :xml => @users }
+        format.xls { send_data @users.to_xls_data, :filename => 'users.xls' }
+      end
+    end
+  end
+
+
+== Dependencies
+
+  spreadsheet gem
+
+== Install
+
+  Include next gems in your environment.rb config file:
+
+    config.gem 'to_xls'
+

data/init.rb

@@ -0,0 +1 @@
+require 'to_xls'

data/lib/to_xls.rb

@@ -0,0 +1,92 @@
+require 'rubygems'
+require 'spreadsheet'
+require 'stringio'
+
+class Hash
+  def to_xls(options = {})
+    book = Spreadsheet::Workbook.new
+
+    each do |key, value|
+      sheet = book.create_worksheet
+      sheet.name = key.to_s
+      value.to_xls({ :sheet => sheet }.merge(options[key] || {}))
+    end
+    
+    return book
+  end
+  
+  def to_xls_data(options = {})
+    data = StringIO.new('')
+    self.to_xls(options).write(data)
+    return data.string
+  end
+end
+
+class Array
+  # Options for to_xls: columns, name, header, sheet
+  def to_xls(options = {})
+    sheet = options[:sheet]
+    unless sheet
+      book = Spreadsheet::Workbook.new
+      sheet = book.create_worksheet
+      sheet.name = options[:name] || 'Sheet 1'
+    end
+
+    if self.any?
+      columns = options[:columns] || self.first.attributes.keys.sort
+
+      if columns.any?
+        line = 0
+        
+        unless options[:headers] == false
+          if options[:headers].is_a?(Array)
+            sheet.row(0).concat options[:headers].collect(&:to_s)
+          else
+            aux_headers_to_xls(self.first, columns, sheet.row(0))
+          end
+          line = 1
+        end
+        
+        self.each do |item|
+          row = sheet.row(line)
+          columns.each {|column| aux_to_xls(item, column, row)}
+          line += 1
+        end
+      end
+    end
+
+    return book || sheet
+  end
+  
+  def to_xls_data(options = {})
+    data = StringIO.new('')
+    self.to_xls(options).write(data)
+    return data.string
+  end
+  
+  private  
+  def aux_to_xls(item, column, row)
+    if item.nil?
+      row.push(nil)
+    elsif column.is_a?(String) or column.is_a?(Symbol)
+      row.push(item.send(column))
+    elsif column.is_a?(Hash)
+      column.each{|key, values| aux_to_xls(item.send(key), values, row)}
+    elsif column.is_a?(Array)
+      column.each{|value| aux_to_xls(item, value, row)}
+    end
+  end
+  
+  def aux_headers_to_xls(item, column, row)
+    if item.nil?
+      row.push(nil)
+    elsif column.is_a?(String) or column.is_a?(Symbol)
+      row.push("#{item.class.name.underscore}_#{column}")
+    elsif column.is_a?(Hash)
+      column.each{|key, values| aux_headers_to_xls(item.send(key), values, row)}
+    elsif column.is_a?(Array)
+      column.each{|value| aux_headers_to_xls(item, value, row)}
+    end
+  end
+  
+end

data/to_xls.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+  s.name = %q{al-to_xls}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Enrique Garcia Cota", "Francisco de Juan", "Alan Larkin"]
+  s.date = %q{2010-10-31}
+  s.description = %q{Transform an Array or Hash into a excel file using the spreadsheet gem.}
+  s.email = %q{alan.larkin+to_xls@gmail.com}
+  s.extra_rdoc_files = [
+    "MIT-LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+    "README.rdoc",
+    "to_xls.gemspec",
+    "init.rb",
+    "lib/to_xls.rb"
+  ]
+  s.homepage = %q{http://github.com/al/to_xls}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{To xls}
+  
+  s.add_dependency("spreadsheet", ">= 0")
+
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: al-to_xls
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Enrique Garcia Cota
+- Francisco de Juan
+- Alan Larkin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-31 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: spreadsheet
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Transform an Array or Hash into a excel file using the spreadsheet gem.
+email: alan.larkin+to_xls@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- to_xls.gemspec
+- init.rb
+- lib/to_xls.rb
+has_rdoc: true
+homepage: http://github.com/al/to_xls
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: To xls
+test_files: []
+