to_xls-rails 1.1.1 → 1.1.2

data/CHANGELOG

@@ -1,18 +1,21 @@
 0.1.0
-  first commit
+  First commit
 
 0.1.1
-  add gem dependency on gemspec file
+  Added gem dependency on gemspec file
 
 0.1.2
-  update documentation
+  Update README.rdoc
 
 1.0.0
-  fix typo
+  Fixed typo
 
 1.1.0
   Translation of a column-value
-  Add options :header
+  Added options :header
 
 1.1.1
-  Add options :header_columns
+  Added options :header_columns
+
+1.1.2
+  Added prepend option. Prepend some data above header and access current array element index in &block

data/Gemfile

@@ -2,3 +2,5 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in refinerycms-multisite.gemspec
 gemspec
+
+gem 'spreadsheet', '~> 0.6.5'

data/README.rdoc

@@ -1,26 +1,36 @@
-== to_xls plugin
+== to_xls-rails
 
-This simple plugin gives you the ability to call to_xls to a collection of activerecords. The builder options are the same as to_json / to_xml, except for the :include.
+This simple plugin gives you the ability to call to_xls to a collection of activerecords for Rails.
+
+
+== Install
+  gem install spreadsheet
+  gem install to_xls-rails
 
 
 == Usage
 
   add below to RAILS_ROOT/config/initializers/mime_types.rb
   Mime::Type.register_alias "text/excel", :xls
-  
+
   @posts = Post.all
-  
+
   #
-  #  default are export header and all fileds
+  # default are export header and all fileds
   #
-    
+
   @posts.to_xls
   @posts.to_xls(:only => [:title, :body])
   @posts.to_xls(:except => [:id])
   @posts.to_xls(:header => false)
 
+  # Will prepend above header
+  # | Col 0, Row 0 | Col 1, Row 0 |
+  # | Col 0, Row 1 |              |
+  @posts.to_xls(:prepend => [["Col 0, Row 0", "Col 1, Row 0"], ["Col 0, Row 1"]])
+
   # Translation of a column-value
-  @posts.to_xls{|column, value| column==:salutation ? t(value) : value}
+  @posts.to_xls{|column, value, row_index| column==:salutation ? t(value) + " at #{row_index}" : value}
 
 
 == Example
@@ -28,34 +38,41 @@ This simple plugin gives you the ability to call to_xls to a collection of activ
   class PostsController < ApplicationController
     def index
       @posts = Post.all
-      
+
       respond_to do |format|
         format.xls { send_data(@posts.to_xls) }
-        #format.xls {
-	      #  filename = "posts-#{Time.now.strftime("%Y%m%d%H%M%S")}.xls" 
-        #  send_data(@posts.to_xls, :type => "application/excel; charset=utf-8; header=present", :filename => filename)
-        #}
+        # format.xls {
+        #   filename = "posts-#{Time.now.strftime("%Y%m%d%H%M%S")}.xls" 
+        #   send_data(@posts.to_xls, :type => "application/excel; charset=utf-8; header=present", :filename => filename)
+        # }
       end
     end
   end
 
 
-== Dependencies
+  Works on Rails 3:
 
-  gem install spreadsheet
-  
+  class PostsController < ApplicationController
+    def index
+      # add this to config/initializers/mime_types.rb
+      Mime::Type.register "application/vnd.ms-excel", :xls
 
-== Install
+      @posts = Post.all
+
+      respond_to do |format|
+        format.xls {
+          send_data @posts.to_xls
+          return # prevet Rails to seek for index.xls.erb
+        }
+      end
+    end
+  end
 
-  with gem
-  gem install to_xls-rails
 
-  with bundler
-  gem 'to_xls-rails'
-  bundle install
+== Contributors
 
-  with git
-  git clone http://github.com/liangwenke/to_xls-rails.git
+* {Juan Pablo Marzetti}[http://github.com/yonpols] Added Support for Value-Substitution
+* {Denis Yagofarov}[http://github.com/denyago] Added prepend some data above header and access current array element index in &block
 
 
 == Note

data/VERSION

@@ -1 +1 @@
-1.1.1
+1.1.2

data/lib/to_xls-rails.rb

@@ -3,8 +3,10 @@ require 'spreadsheet'
 class Array
 
   def to_xls(options = {}, &block)
-    return '' if self.empty?
-    
+
+    return '' if self.empty? && options[:prepend].blank?
+
+    columns = []
     options.reverse_merge!(:header => true)
 
     xls_report = StringIO.new
@@ -13,23 +15,33 @@ class Array
 
     if options[:only]
       columns = Array(options[:only]).map(&:to_sym)
-    else
+    elsif !self.empty?
       columns = self.first.class.column_names.map(&:to_sym) - Array(options[:except]).map(&:to_sym)
     end
 
-    return '' if columns.empty?
+    return '' if columns.empty? && options[:prepend].blank?
+
+    sheet_index = 0
+
+    unless options[:prepend].blank?
+      options[:prepend].each do |array|
+        sheet.row(sheet_index).concat(array)
+        sheet_index += 1
+      end
+    end
 
     if options[:header]
-      sheet.row(0).concat(options[:header_columns].blank? ? columns.map(&:to_s).map(&:humanize) : options[:header_columns])
+      sheet.row(sheet_index).concat(options[:header_columns].blank? ? columns.map(&:to_s).map(&:humanize) : options[:header_columns])
+      sheet_index += 1
     end
 
     self.each_with_index do |obj, index|
-      index = options[:header] ? (index + 1) : index
       if block
-        sheet.row(index).replace(columns.map { |column| block.call(column, obj.send(column)) })
+        sheet.row(sheet_index).replace(columns.map { |column| block.call(column, obj.send(column), index) })
       else
-        sheet.row(index).replace(columns.map { |column| obj.send(column) })
+        sheet.row(sheet_index).replace(columns.map { |column| obj.send(column) })
       end
+      sheet_index += 1
     end
 
     book.write(xls_report)

data/to_xls-rails.gemspec

@@ -5,16 +5,16 @@ version = File.read(File.expand_path("../VERSION", __FILE__)).strip
 Gem::Specification.new do |s|
   s.name = 'to_xls-rails'
   s.version = version
-  s.author = "LiangWenKe"
+  s.author = "Mike Liang"
   s.email = "liangwenke.com@gmail.com"
   s.homepage = "http://github.com/liangwenke/to_xls-rails"
-  s.summary     = "Export data to xls on Rails"
-  s.description = "This simple plugin gives you the ability to call to_xls to a collection of activerecords. The builder options are the same as to_json / to_xml, except for the :include."
+  s.summary     = "Export Rails ActiveRecord data to excel file"
+  s.description = "This simple plugin gives you the ability to call to_xls to a collection of activerecords for Rails."
   
   s.files        = Dir["{lib,test}/**/*", "[a-zA-Z]*", "init.rb"] - ["Gemfile.lock"]
   s.require_path = "lib"
   
-  s.add_dependency('spreadsheet', '~>0.6.5')
+  s.add_dependency('spreadsheet', '~> 0.6.5')
 
   s.platform = Gem::Platform::RUBY
   s.required_rubygems_version = ">= 1.3.4"

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: to_xls-rails
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
   prerelease: 
 platform: ruby
 authors:
-- LiangWenKe
+- Mike Liang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-16 00:00:00.000000000Z
+date: 2012-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spreadsheet
-  requirement: &2152315200 !ruby/object:Gem::Requirement
+  requirement: &70151257218860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,9 @@ dependencies:
         version: 0.6.5
   type: :runtime
   prerelease: false
-  version_requirements: *2152315200
+  version_requirements: *70151257218860
 description: This simple plugin gives you the ability to call to_xls to a collection
-  of activerecords. The builder options are the same as to_json / to_xml, except for
-  the :include.
+  of activerecords for Rails.
 email: liangwenke.com@gmail.com
 executables: []
 extensions: []
@@ -59,8 +58,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.4
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.12
 signing_key: 
 specification_version: 3
-summary: Export data to xls on Rails
+summary: Export Rails ActiveRecord data to excel file
 test_files: []