to-csv 1.0.0

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+== 1.0.0
+
+* First release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ícaro Leopoldino da Motta
+
+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,188 @@
+= ToCSV
+
+
+ToCSV is a gem for converting arrays to CSV by calling +to_csv+.
+These arrays can contain different data structures, as long as they are homogeneous, like the ones
+described below:
+
+* A simple array of anything that responds to <tt>to_s</tt>: <tt>['Date', Time.now].to_csv</tt>
+* An array of hashes: <tt>[ {'Name' => 'Icaro', 'Age' => 23}, {'Name' => 'Gabriel', 'Age' => 16} ].to_csv</tt>
+* A matrix: <tt>[['Name', 'Age'], ['Icaro', 23], ['Gabriel', 16]].to_csv</tt>
+* A hash like array: <tt>[ [['Name', 'Icaro'], ['Age', 23]], [['Name', 'Gabriel'], ['Age', 16]] ].to_csv</tt>
+* An array of ActiveRecord objects: <tt>@users.to_csv(:except => [:password, :phone], :timestamps => true)</tt>
+
+
+=== Requirements
+
+You must have FasterCSV installed:
+  $ sudo gem install fastercsv
+
+And also ActiveSupport:
+  $ sudo gem install active_support
+
+ToCSV has been tested with Ruby 1.8.6/1.8.7.
+
+
+=== Configuration
+
+  If you want to use this gem with Rails, put the following requirement in your environment.rb:
+
+  config.gem 'to-csv', :lib => 'to_csv', :source => 'http://gemcutter.org'
+
+After that, if you need to globally configure the gem, just create a <i>to_csv.rb</i> file in <i>initializers</i>.
+
+  ToCSV.byte_order_marker = true
+  ToCSV.timestamps        = true
+  ToCSV.locale            = 'en-US'
+  ToCSV.primary_key       = false
+  ToCSV.csv_options       = { :col_sep => ',', :row_sep => "\r\n" }
+
+
+== Examples
+
+Let's start with the most simple example.
+
+  ['Alfred Hitchcock', 'Robert Mitchum', 'Lucille Ball'].to_csv
+  #=> "Alfred Hitchcock;Robert Mitchum;Lucille Ball\n"
+
+
+Or, if we have an array of arrays (i.e. a matrix) we can create tabular data.
+  [
+    ['Name', 'Gender'],
+    ['Alfred',  'M'],
+    ['Robert',  'M'],
+    ['Lucille', 'F']
+  ].to_csv #=> "Name;Gender\nAlfred;M\nRobert;M\nLucille;F\n"
+
+
+Almost always, when we generate CSV files, we want it to have appropriate
+headers, so a better approach might be to use an array of hashes.
+
+  [
+    { 'Name' => 'Alfred',  'Gender' => 'M' },
+    { 'Name' => 'Robert',  'Gender' => 'M' },
+    { 'Name' => 'Lucille', 'Gender' => 'F' }
+  ].to_csv #=> "Gender;Name\nM;Alfred\nM;Robert\nF;Lucille\n"
+
+
+Look carefully to the above output. You can see that when we use hashes we can
+no longer be sure of the headers' order. When we are working with tabular data
+the headers' order can be very important, thus we can use a somewhat similar
+data structure:
+
+  [
+    [ ['Name', 'Alfred'],  ['Gender', 'M'] ],
+    [ ['Name', 'Robert'],  ['Gender', 'M'] ],
+    [ ['Name', 'Lucille'], ['Gender', 'F'] ]
+  ].to_csv #=> "Name;Gender\nAlfred;M\nRobert;M\nLucille;F\n"
+
+That's a lot to type... The first example was much simpler...
+
+There is the <tt>headers</tt> option. You can use it in all the examples above
+to enable/disable headers from the output. Default is to show (true).
+
+  users = [{ 'Name' => 'Alfred',  'Gender' => 'M' }]
+  users.to_csv(:headers => false)
+
+
+==== Active Record Objects
+
+When we're building our data like the previous examples we have very few options
+compared to what can be passed when converting an array of AR objects. Again,
+the easiest way:
+
+  # Anywhere in your app.
+  # By default, all available model attributes (DB columns) are going to be used
+  # except timestamps and the primary key of the record
+  @users = User.all
+  File.open('path/to/file.csv', 'w') { |io| io.puts @users.to_csv }
+
+
+==== Headers
+
+You can control the order and the text of any header. You can accomplish that
+in various ways.
+
+By default all attribute/method names will be sorted in alphabetical order. So
+imagine a person model have +name+, +age+ and +email+ as attributes, and you
+want to get the following output:
+
+  Name | E-mail | Age
+  ...  | ...    | ..
+  ...  | ...    | ..
+
+You can tell <i>to-csv</i> to use a specific locale. If you don't, it uses
+your app current locale. It will try to translate attributes to a
+more friendly text by using the scope <tt>[:activerecord, :attributes, <model name>]</tt>.
+If the translation doesn't exist the header's text is going to be humanized.
+
+The order of columns can be changed with the option +headers+. The way this
+option works is very similar to the <tt>plugins</tt> method in your Rails
+<i>environment.rb</i> file.
+
+* If you pass +nil+ (default) then headers/columns will be in alphabetical order.
+* If you pass an empty array or +false+, no headers will be shown.
+* Instead, if you pass a non empty array, headers will be sorted in the order specified. <tt>:all</tt> can be used as a placeholder for all attributes not explicitly named.
+
+So, in our example above, we can say:
+
+  @users.to_csv(:headers => [:name, :email, :age])
+
+Or, using the placeholder +all+, which is not very useful here:
+
+  @users.to_csv(:headers => [:name, :email, :all])
+
+If you want a completely different result you could, for instance, map all
+users to a hash. Example:
+
+  # This makes use of a hash to completely change the CSV output.
+  @users.map do |user|
+    {
+      'Name' => user.name,
+      'Age' => user.age,
+      'Total Comments' => user.comments.count
+    }
+  end.to_csv
+
+
+===== Passing a Block
+
+Sometimes you may want to change just one value out of six for example. The best
+way to go is to pass a block so that you don't have to repeat yourself writing
+five headers and it's obvious values and also loosing I18n translations.
+
+  # The block yields a new OpenStruct for each object in the list. By calling
+  # methods on this struct you can change their default values.
+  @users.to_csv do |csv, user|
+    csv.date_of_birth = user.date_of_birth.to_s(:long)
+  end
+
+
+===== A More Complete Example
+
+  # index.html.haml
+  = link_to 'export (CSV)', users_url(:csv)
+
+  # index action in users controller
+  def index
+    @users = User.all
+    respond_to do |format|
+      format.html
+      format.csv { send_data @users.to_csv, :filename => 'users_report.csv' }
+    end
+  end
+
+
+==== Full Customization
+
+You can always customize the output if you wish by building arrays of hashes,
+arrays of arrays of bidimensional arrays etc :). Or you can obviously mix
+anything you want and even use FasterCSV directly.
+
+  @user.to_csv { :only => [:name, :email] }, :col_sep => ','
+
+There are other options for you to customize the output. Take a look at the
+<tt>to_csv</tt> method documentation.
+
+Copyright (c) 2009 Ícaro Leopoldino da Motta, released under the MIT license.
+

data/Rakefile

@@ -0,0 +1,36 @@
+#encoding: utf-8
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+load 'test/tasks.rake'
+
+TO_CSV_VERSION = '1.0.0'
+CLEAN.include('pkg')
+
+spec = Gem::Specification.new do |s|
+  s.author = "Ícaro Leopoldino da Motta"
+  s.email = "icaro.ldm@gmail.com"
+  s.platform = Gem::Platform::RUBY
+  s.name = "to-csv"
+  s.summary = s.description = "Convert arrays to CSV (array of hashes, matrixes, ActiveRecord objects etc)."
+  s.homepage = "http://github.com/ilmotta/to-csv"
+  s.version = TO_CSV_VERSION
+
+  s.add_dependency 'fastercsv', '>= 1.5.0'
+  s.add_dependency 'activesupport', '>= 2.3.5'
+
+  s.has_rdoc = true
+  s.require_path = "lib"
+  s.extra_rdoc_files = FileList['*.rdoc']
+  s.files = FileList['init.rb', 'MIT-LICENSE', 'Rakefile', 'lib/**/*', 'test/**/*']
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.define
+end
+
+task :build => [:clean, :repackage]
+
+task :default => :test
+

data/init.rb

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

data/lib/to_csv.rb

@@ -0,0 +1,59 @@
+require 'fastercsv'
+require 'ostruct'
+require 'active_support'
+require 'to_csv/csv_converter'
+
+module ToCSV
+  mattr_accessor :byte_order_marker, :locale, :primary_key, :timestamps
+  mattr_accessor :csv_options
+  self.csv_options = { :col_sep => ';' }
+end
+
+class Array
+
+  #
+  # Returns a CSV string.
+  #
+  # ==== Available Options:
+  #
+  # 1. *options*
+  #    +byte_order_marker+::
+  #      If true, a Byte Order Maker (BOM) will be inserted at
+  #      the beginning of the output. It's useful if you want to force
+  #      MS Excel to read UTF-8 encoded files, otherwise it will just
+  #      decode them as Latin1 (ISO-8859-1). Default: +false+.
+  #    +only+::
+  #      Same behavior as with the +to_json+ method.
+  #    +except+::
+  #      Same as +only+ option.
+  #    +methods+::
+  #      Accepts a symbol or an array with additional methods to be included.
+  #    +timestamps+::
+  #      Include timestamps +created_at+, +created_on+, +updated_at+ and
+  #      +updated_on+. If false Default: +false+.
+  #    +primary_key+::
+  #      If +true+ the object's primary key will be added as an attribute,
+  #      which in turn will be mapped to a CSV column. Default: +false+.
+  #    +headers+::
+  #       If this list is <tt>nil</tt> then headers will be in alphabetical order.
+  #       If it is an empty array or <tt>false</tt>, no headers will be shown.
+  #       If it is non empty, headers will be sorted in the order specified.
+  #       <tt>:all</tt> can be used as a placeholder for all attributes not
+  #       explicitly named.
+  #    +locale+::
+  #      In a Rails environment, it will automatically take the current locale
+  #      and will use it to translate the columns to friendly headers.
+  #      Methods will be translated from
+  #      <tt>[:activerecord, :attributes, <model>]</tt>. If the translation
+  #      is missing, then a simple humanize will be called.
+  #
+  # 2. *csv_options*
+  #    Accepts all options listed in <tt>FasterCSV::DEFAULT_OPTIONS</tt>.
+  #
+  def to_csv(options = {}, csv_options = {}, &block)
+    return '' if empty?
+    csv_converter = ToCSV::Converter.new(self, options, csv_options, &block)
+    csv_converter.to_csv
+  end
+end
+

data/lib/to_csv/csv_converter.rb

@@ -0,0 +1,169 @@
+module ToCSV
+  class Converter
+     
+    def initialize(data, options = {}, csv_options = {}, &block)
+      @opts = options.to_options.reverse_merge({
+        :byte_order_marker => ToCSV.byte_order_marker,
+        :locale            => ToCSV.locale || ::I18n.locale,
+        :primary_key       => ToCSV.primary_key,
+        :timestamps        => ToCSV.timestamps
+      })
+            
+      @opts[:only]    = Array(@opts[:only]).map(&:to_s)
+      @opts[:except]  = Array(@opts[:except]).map(&:to_s)
+      @opts[:methods] = Array(@opts[:methods]).map(&:to_s)
+
+      @data = data
+      @block = block
+      @csv_options = csv_options.to_options.reverse_merge(ToCSV.csv_options)
+    end
+
+    def to_csv
+      build_headers_and_rows
+      
+      output = ::FasterCSV.generate(@csv_options) do |csv|
+        csv << @header_row if @header_row.try(:any?)
+        @rows.each { |row| csv << row }
+      end
+      
+      @opts[:byte_order_marker] ? "\xEF\xBB\xBF#{output}" : output
+    end
+
+    private
+
+      def build_headers_and_rows
+        send "headers_and_rows_from_#{ discover_data_type }"
+      end
+  
+      def discover_data_type
+        test_data = @data.first
+        return 'ar_object' if instance_of_active_record? test_data
+        return 'hash' if test_data.is_a? Hash
+        return 'unidimensional_array' if test_data.is_a?(Array) && !test_data.first.is_a?(Array)
+        return 'bidimensional_array' if test_data.is_a?(Array) && test_data.first.is_a?(Array) && test_data.first.size == 2
+        'simple_data'
+      end
+      
+      def instance_of_active_record?(obj)
+        obj.class.base_class.superclass == ActiveRecord::Base
+      rescue Exception
+        false
+      end
+  
+      def headers_and_rows_from_simple_data
+        @header_row = nil
+        @rows = [@data.dup]
+      end
+  
+      def headers_and_rows_from_hash
+        @header_row = @data.first.keys if display_headers?
+        @rows = @data.map(&:values)
+      end
+  
+      def headers_and_rows_from_unidimensional_array
+        @header_row = @data.first if display_headers?
+        @rows = @data[1..-1]
+      end
+  
+      def headers_and_rows_from_bidimensional_array
+        @header_row = @data.first.map(&:first) if display_headers?
+        @rows = @data.map { |array| array.map(&:last) }
+      end
+  
+      def headers_and_rows_from_ar_object
+        attributes = sort_attributes(filter_attributes(attribute_names))
+        @header_row = human_attribute_names(attributes) if display_headers?
+  
+        @rows = if @block
+          @data.map do |item|
+            os = OpenStruct.new
+            @block.call(os, item)
+            marshal_dump = os.marshal_dump
+            attributes.map { |attribute| marshal_dump[attribute.to_sym] || try_formatting_date(item.send(attribute)) }
+          end
+        else
+          @data.map do |item|
+            attributes.map { |attribute| try_formatting_date item.send(attribute) }
+          end
+        end
+      end
+      
+      def display_headers?
+        @opts[:headers].nil? || (Array(@opts[:headers]).any? && Array(@opts[:headers]).all? { |h| h != false })
+      end
+      
+      def human_attribute_names(attributes)
+        @opts[:locale] ? translate(attributes) : humanize(attributes)
+      end
+      
+      def humanize(attributes)
+        attributes.map(&:humanize)
+      end
+      
+      def translate(attributes)
+        ::I18n.with_options :locale => @opts[:locale], :scope => [:activerecord, :attributes, @data.first.class.to_s.underscore] do |locale|
+          attributes.map { |attribute| locale.t(attribute, :default => attribute.humanize) }
+        end
+      end
+      
+      def try_formatting_date(value)
+        is_a_date?(value) ? value.to_s : value
+      end
+      
+      def is_a_date?(value)
+        value.is_a?(Time) || value.is_a?(Date) || value.is_a?(DateTime)
+      end
+      
+      def primary_key_filter(attributes)
+        return attributes if @opts[:primary_key]
+        attributes - Array(@data.first.class.primary_key.to_s)
+      end
+      
+      def timestamps_filter(attributes)
+        return attributes if @opts[:timestamps]
+        return attributes if (@opts[:only] + @opts[:except]).any? { |attribute| timestamps.include? attribute }
+        attributes - timestamps
+      end
+      
+      def timestamps
+        %w[ created_at updated_at created_on updated_on ]
+      end
+      
+      def methods_filter(attributes)
+        attributes | @opts[:methods]
+      end
+      
+      def only_filter(attributes)
+        return attributes if @opts[:only].empty?
+        attributes & @opts[:only]
+      end
+      
+      def except_filter(attributes)
+        attributes - @opts[:except]
+      end
+      
+      def attribute_names
+        @data.first.attribute_names.map(&:to_s)
+      end
+      
+      def filter_attributes(attributes)
+        attributes = methods_filter(attributes)
+        attributes = primary_key_filter(attributes)
+        attributes = timestamps_filter(attributes)
+        attributes = @opts[:only].any?? only_filter(attributes) : except_filter(attributes)
+        attributes
+      end
+      
+      def sort_attributes(attributes)
+        attributes = attributes.map(&:to_s).sort
+        return attributes if @opts[:headers].nil?
+        headers = Array(@opts[:headers]).map(&:to_s)
+        headers.delete_if { |attribute| attribute == 'false' }
+        if index = headers.index('all')
+          (headers & attributes).insert(index, (attributes - headers)).flatten
+        else
+          headers + (attributes - headers)
+        end
+      end
+  end
+end

data/test/database.yml

@@ -0,0 +1,4 @@
+sqlite3:
+  database: ":memory:"
+  adapter: sqlite3
+  timeout: 500

data/test/fixtures/movie.rb

@@ -0,0 +1,2 @@
+class Movie < ActiveRecord::Base
+end

data/test/fixtures/movies.yml

@@ -0,0 +1,19 @@
+the_dark_knight:
+  id: 1
+  title: The Dark Knight
+  subtitles: English, French, Spanish
+  studio: Warner Home Video
+  number_of_discs: 2
+  dvd_release_date: <%= DateTime.new 2008, 12, 9 %>
+  created_at: <%= Date.new 2009, 12, 12 %>
+  updated_at: <%= Date.new 2009, 12, 12 %>
+
+2001_space_odyssey:
+  id: 2
+  title: 2001 - A Space Odyssey
+  subtitles: English, Spanish, French
+  studio: Warner Home Video
+  number_of_discs: 1
+  dvd_release_date: <%= DateTime.new 2007, 10, 23 %>
+  created_at: <%= Date.new 2009, 11, 11 %>
+  updated_at: <%= Date.new 2009, 11, 11 %>

data/test/fixtures/people.yml

@@ -0,0 +1,7 @@
+icaro:
+  cod: 1
+  name: Icaro
+  
+gabriel:
+  cod: 2
+  name: Gabriel

data/test/fixtures/person.rb

@@ -0,0 +1,3 @@
+class Person < ActiveRecord::Base
+  set_primary_key :cod
+end

data/test/fixtures/schema.rb

@@ -0,0 +1,12 @@
+ActiveRecord::Schema.define do
+  create_table :movies, :force => true do |t|
+    t.string :title, :subtitles, :studio
+    t.integer :number_of_discs
+    t.datetime :dvd_release_date
+    t.timestamps
+  end
+  
+  create_table :people, :primary_key => :cod, :force => true do |t|
+    t.string :name
+  end
+end

data/test/lib/activerecord_test_case.rb

@@ -0,0 +1,20 @@
+require 'lib/activerecord_test_connector'
+
+class ActiveRecordTestCase < Test::Unit::TestCase
+  if defined? ActiveSupport::Testing::SetupAndTeardown
+    include ActiveSupport::Testing::SetupAndTeardown
+  end
+ 
+  if defined? ActiveRecord::TestFixtures
+    include ActiveRecord::TestFixtures
+  end
+  
+  self.fixture_path = ActiveRecordTestConnector::FIXTURES_PATH
+  self.use_transactional_fixtures = true
+  
+  def self.fixtures(*args)
+    super
+  end
+end
+
+ActiveRecordTestConnector.setup

data/test/lib/activerecord_test_connector.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'active_record'
+require 'active_record/fixtures'
+
+class ActiveRecordTestConnector
+  FIXTURES_PATH = File.join(File.dirname(__FILE__), '..', 'fixtures')
+  
+  def self.setup
+    setup_connection
+    load_schema
+    add_load_path FIXTURES_PATH
+  end
+  
+  private
+  
+    def self.add_load_path(path)
+      dep = defined?(ActiveSupport::Dependencies) ? ActiveSupport::Dependencies : ::Dependencies
+      dep.load_paths.unshift path
+    end
+    
+    def self.load_schema
+      ActiveRecord::Base.silence do
+        ActiveRecord::Migration.verbose = false
+        load File.join(FIXTURES_PATH, 'schema.rb')
+      end
+    end
+  
+    def self.setup_connection
+      configurations = YAML.load_file(File.join(File.dirname(__FILE__), '..', 'database.yml'))
+      ActiveRecord::Base.establish_connection configurations['sqlite3']
+    end
+end

data/test/lib/load_fixtures.rb

@@ -0,0 +1,9 @@
+require 'lib/activerecord_test_connector'
+
+# setup the connection
+ActiveRecordTestConnector.setup
+ 
+# load all fixtures
+Fixtures.create_fixtures(ActiveRecordTestConnector::FIXTURES_PATH, ActiveRecord::Base.connection.tables)
+ 
+require 'to_csv'

data/test/locales/en-US.yml

@@ -0,0 +1,28 @@
+"en-US":
+  date:
+    formats:
+      default: "%Y-%m-%d"
+      short: "%e %b"
+      long: "%B %e, %Y"
+      only_day: "%e"
+
+    day_names: [Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday]
+    abbr_day_names: [Sun, Mon, Tue, Wed, Thu, Fri, Sat]
+    month_names: [~, January, February, March, April, May, June, July, August, September, October, November, December]
+    abbr_month_names: [~, Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec]
+    order: [ :year, :month, :day ]
+  
+  time:
+    formats:
+      default: "%a %b %d %H:%M:%S %Z %Y"
+      time: "%H:%M"
+      short: "%d %b %H:%M"
+      long: "%B %d, %Y %H:%M"
+      only_second: "%S"
+      
+      datetime:
+        formats:
+          default: "%Y-%m-%dT%H:%M:%S%Z"
+          
+      am: 'am'
+      pm: 'pm'

data/test/locales/pt-BR.yml

@@ -0,0 +1,147 @@
+# formatos de data e hora
+date:
+  formats:
+    default: "%d/%m/%Y"
+    short: "%d de %B"
+    long: "%d de %B de %Y"
+  
+  day_names: [Domingo, Segunda, Terça, Quarta, Quinta, Sexta, Sábado]
+  abbr_day_names: [Dom, Seg, Ter, Qua, Qui, Sex, Sáb]
+  month_names: [~, Janeiro, Fevereiro, Março, Abril, Maio, Junho, Julho, Agosto, Setembro, Outubro, Novembro, Dezembro]
+  abbr_month_names: [~, Jan, Fev, Mar, Abr, Mai, Jun, Jul, Ago, Set, Out, Nov, Dez]
+  order: [ :day, :month, :year ]
+
+time:
+  formats:
+    default: "%A, %d de %B de %Y, %H:%M h"
+    short: "%d/%m, %H:%M h"
+    long: "%A, %d de %B de %Y, %H:%M h"
+  am: ''
+  pm: ''
+
+# date helper distanci em palavras
+datetime:
+  distance_in_words:
+    half_a_minute: 'meio minuto'
+    less_than_x_seconds:
+      one: 'menos de 1 segundo'
+      other: 'menos de {{count}} segundos'
+    
+    x_seconds:
+      one: '1 segundo'
+      other: '{{count}} segundos'
+    
+    less_than_x_minutes:
+      one: 'menos de um minuto'
+      other: 'menos de {{count}} minutos'
+    
+    x_minutes:
+      one: '1 minuto'
+      other: '{{count}} minutos'
+    
+    about_x_hours:
+      one: 'aproximadamente 1 hora'
+      other: 'aproximadamente {{count}} horas'
+    
+    x_days:
+      one: '1 dia'
+      other: '{{count}} dias'
+    
+    about_x_months:
+      one: 'aproximadamente 1 mês'
+      other: 'aproximadamente {{count}} meses'
+    
+    x_months:
+      one: '1 mês'
+      other: '{{count}} meses'
+    
+    about_x_years:
+      one: 'aproximadamente 1 ano'
+      other: 'aproximadamente {{count}} anos'
+    
+    over_x_years:
+      one: 'mais de 1 ano'
+      other: 'mais de {{count}} anos'
+  prompts:
+    year:   "Ano"
+    month:  "Mês"
+    day:    "Dia"
+    hour:   "Hora"
+    minute: "Minuto"
+    second: "Segundos"
+
+# numeros
+number:
+  format:
+    precision: 3
+    separator: ','
+    delimiter: '.'
+  currency:
+    format:
+      unit: 'R$'
+      precision: 2
+      format: '%u %n'
+      separator: ','
+      delimiter: '.'
+  percentage:
+    format:
+      delimiter: '.'
+  precision:
+    format:
+      delimiter: '.'
+  human:
+    format:
+      precision: 1
+      delimiter: '.'
+    storage_units:
+      format: "%n %u"
+      units:
+        byte:
+          one: "Byte"
+          other: "Bytes"
+        kb: "KB"
+        mb: "MB"
+        gb: "GB"
+        tb: "TB"
+
+# Used in array.to_sentence.
+support:
+  array:
+    words_connector: ", "
+    two_words_connector: " e "
+    last_word_connector: " e "
+  
+# Active Record
+activerecord:
+  errors:
+    template:
+      header:
+        one: "Não foi possível gravar {{model}}: 1 erro"
+        other: "Não foi possível gravar {{model}}: {{count}} erros."
+      body: "Por favor, verifique o(s) seguinte(s) campo(s):"
+    messages:
+      inclusion: "não está incluído na lista"
+      exclusion: "não está disponível"
+      invalid: "não é válido"
+      confirmation: "não está de acordo com a confirmação"
+      accepted: "deve ser aceito"
+      empty: "não pode ficar vazio"
+      blank: "não pode ficar em branco"
+      too_long: "é muito longo (máximo: {{count}} caracteres)"
+      too_short: "é muito curto (mínimo: {{count}} caracteres)"
+      wrong_length: "não possui o tamanho esperado ({{count}} caracteres)"
+      taken: "já está em uso"
+      not_a_number: "não é um número"
+      greater_than: "deve ser maior do que {{count}}"
+      greater_than_or_equal_to: "deve ser maior ou igual a {{count}}"
+      equal_to: "deve ser igual a {{count}}"
+      less_than: "deve ser menor do que {{count}}"
+      less_than_or_equal_to: "deve ser menor ou igual a {{count}}"
+      odd: "deve ser ímpar"
+      even: "deve ser par"
+  attributes:
+    movie:
+      title: Título
+      subtitles: Legendas
+      number_of_discs: Número de Discos
+      dvd_release_date: Data de Lançamento do DVD

data/test/tasks.rake

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+desc 'Test to_csv plugin'
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+  t.libs << 'test'
+end

data/test/to_csv_test.rb

@@ -0,0 +1,148 @@
+require 'test/unit'
+require 'test/lib/activerecord_test_case'
+require 'test/lib/load_fixtures'
+
+class ToCsvTest < ActiveRecordTestCase
+  fixtures :movies
+
+  def setup
+    ToCSV.byte_order_marker = ToCSV.locale = ToCSV.primary_key = ToCSV.timestamps = false
+    ToCSV.csv_options = { :col_sep => ';' }
+    @movies = Movie.all
+    @people = Person.all(:order => :name)
+    store_translations('en-US', 'pt-BR')
+  end
+
+  def test_simple_array
+    csv = ['Alfred Hitchcock', 'Robert Mitchum', 'Lucille Ball'].to_csv
+    assert_equal "Alfred Hitchcock;Robert Mitchum;Lucille Ball\n", csv
+  end
+
+  def test_matrix
+    csv = [
+      ['Name', 'Age'],
+      ['Icaro', 22],
+      ['Gabriel', 16]
+    ].to_csv
+
+    assert_equal "Name;Age\nIcaro;22\nGabriel;16\n", csv
+  end
+
+  def test_array_of_matrixes
+    csv = [
+      [
+        ['Name', 'Alfred'],
+        ['Gender', 'M']
+      ],
+      [
+        ['Name', 'Robert'],
+        ['Gender', 'M']
+      ],
+      [
+        ['Name', 'Lucille'],
+        ['Gender', 'F']
+      ]
+    ].to_csv
+
+    assert_equal "Name;Gender\nAlfred;M\nRobert;M\nLucille;F\n", csv
+  end
+
+  def test_array_of_hashes
+    csv = [
+      {
+        'Name'   => 'Icaro',
+        'E-mail' => 'icaro.ldm@gmail.com'
+      },
+      {
+        'Name'   => 'Gabriel',
+        'E-mail' => 'gaby@gmail.com'
+      }
+    ].to_csv
+
+    order_01 = "Name;E-mail\nIcaro;icaro.ldm@gmail.com\nGabriel;gaby@gmail.com\n"
+    order_02 = "E-mail;Name\nicaro.ldm@gmail.com;Icaro\ngaby@gmail.com;Gabriel\n"
+
+
+    assert order_01 == csv || order_02 == csv
+  end
+
+  def test_without_options
+    assert_equal "Dvd release date;Number of discs;Studio;Subtitles;Title\nMon Dec 08 22:00:00 -0200 2008;2;Warner Home Video;English, French, Spanish;The Dark Knight\nMon Oct 22 22:00:00 -0200 2007;1;Warner Home Video;English, Spanish, French;2001 - A Space Odyssey\n", @movies.to_csv
+  end
+
+  def test_only_option
+    assert_equal "Title\nThe Dark Knight\n2001 - A Space Odyssey\n", @movies.to_csv(:only => :title)
+    assert_equal @movies.to_csv(:only => :title), @movies.to_csv(:only => [:title])
+    assert_equal "Studio;Title\nWarner Home Video;The Dark Knight\nWarner Home Video;2001 - A Space Odyssey\n", @movies.to_csv(:only => [:title, :studio])
+  end
+
+  def test_except_option
+    assert_equal "Dvd release date;Number of discs;Subtitles;Title\nMon Dec 08 22:00:00 -0200 2008;2;English, French, Spanish;The Dark Knight\nMon Oct 22 22:00:00 -0200 2007;1;English, Spanish, French;2001 - A Space Odyssey\n", @movies.to_csv(:except => :studio)
+    assert_equal @movies.to_csv(:except => :studio), @movies.to_csv(:except => [:studio])
+    assert_equal "Dvd release date;Number of discs;Studio\nMon Dec 08 22:00:00 -0200 2008;2;Warner Home Video\nMon Oct 22 22:00:00 -0200 2007;1;Warner Home Video\n", @movies.to_csv(:except => [:title, :subtitles])
+  end
+
+  def test_timestamps_option
+   assert_equal "Created at;Number of discs\nSat Dec 12 00:00:00 -0200 2009;2\nWed Nov 11 00:00:00 -0200 2009;1\n", @movies.to_csv(:except => [:title, :subtitles, :studio, :dvd_release_date, :updated_at])
+   assert_equal "Created at;Number of discs\nSat Dec 12 00:00:00 -0200 2009;2\nWed Nov 11 00:00:00 -0200 2009;1\n", @movies.to_csv(:except => [:title, :subtitles, :studio, :dvd_release_date, :updated_at], :timestamps => false)
+   assert_equal "Created at;Number of discs\nSat Dec 12 00:00:00 -0200 2009;2\nWed Nov 11 00:00:00 -0200 2009;1\n", @movies.to_csv(:except => [:title, :subtitles, :studio, :dvd_release_date, :updated_at], :timestamps => true)
+  end
+
+  def test_headers_option
+    assert_equal "Icaro;23\n", ['Icaro', 23].to_csv(:headers => false)
+    assert_equal "Icaro;23\n", [ [:name, :age], ['Icaro', 23] ].to_csv(:headers => false)
+    assert_equal "Icaro;23\n", [ [[:name, 'Icaro'], [:age, 23]] ].to_csv(:headers => false)
+    assert_equal "Subtitles;Dvd release date;Number of discs;Studio;Title\nEnglish, French, Spanish;Mon Dec 08 22:00:00 -0200 2008;2;Warner Home Video;The Dark Knight\nEnglish, Spanish, French;Mon Oct 22 22:00:00 -0200 2007;1;Warner Home Video;2001 - A Space Odyssey\n", @movies.to_csv(:headers => :subtitles)
+    assert_equal "Mon Dec 08 22:00:00 -0200 2008;2;Warner Home Video;English, French, Spanish;The Dark Knight\nMon Oct 22 22:00:00 -0200 2007;1;Warner Home Video;English, Spanish, French;2001 - A Space Odyssey\n", @movies.to_csv(:headers => false)
+    assert_equal "Mon Dec 08 22:00:00 -0200 2008;2;Warner Home Video;English, French, Spanish;The Dark Knight\nMon Oct 22 22:00:00 -0200 2007;1;Warner Home Video;English, Spanish, French;2001 - A Space Odyssey\n", @movies.to_csv(:headers => [false])
+    assert_equal "Mon Dec 08 22:00:00 -0200 2008;2;Warner Home Video;English, French, Spanish;The Dark Knight\nMon Oct 22 22:00:00 -0200 2007;1;Warner Home Video;English, Spanish, French;2001 - A Space Odyssey\n", @movies.to_csv(:headers => [])
+    assert_equal "Title;Number of discs\nThe Dark Knight;2\n2001 - A Space Odyssey;1\n", @movies.to_csv(:headers => [:title, :number_of_discs], :only => [:number_of_discs, :title])
+    assert_equal "Title;Number of discs\nThe Dark Knight;2\n2001 - A Space Odyssey;1\n", @movies.to_csv(:headers => [:title, :all], :only => [:number_of_discs, :title])
+    assert_equal "Title;Number of discs\nThe Dark Knight;2\n2001 - A Space Odyssey;1\n", @movies.to_csv(:headers => :title, :only => [:number_of_discs, :title])
+    assert_equal "Dvd release date;Number of discs;Studio;Subtitles;Title\nMon Dec 08 22:00:00 -0200 2008;2;Warner Home Video;English, French, Spanish;The Dark Knight\nMon Oct 22 22:00:00 -0200 2007;1;Warner Home Video;English, Spanish, French;2001 - A Space Odyssey\n", @movies.to_csv(:headers => :all)
+    assert_equal "Dvd release date;Number of discs;Studio;Subtitles;Title\nMon Dec 08 22:00:00 -0200 2008;2;Warner Home Video;English, French, Spanish;The Dark Knight\nMon Oct 22 22:00:00 -0200 2007;1;Warner Home Video;English, Spanish, French;2001 - A Space Odyssey\n", @movies.to_csv(:headers => [:all])
+    assert_equal "Dvd release date;Studio;Subtitles;Title;Number of discs\nMon Dec 08 22:00:00 -0200 2008;Warner Home Video;English, French, Spanish;The Dark Knight;2\nMon Oct 22 22:00:00 -0200 2007;Warner Home Video;English, Spanish, French;2001 - A Space Odyssey;1\n", @movies.to_csv(:headers => [:all, :subtitles, :title, :number_of_discs])
+  end
+
+  def test_locale_option
+    assert_equal "Data de Lançamento do DVD;Número de Discos;Studio;Legendas;Título\nMon Dec 08 22:00:00 -0200 2008;2;Warner Home Video;English, French, Spanish;The Dark Knight\nMon Oct 22 22:00:00 -0200 2007;1;Warner Home Video;English, Spanish, French;2001 - A Space Odyssey\n", @movies.to_csv(:locale => 'pt-BR')
+  end
+
+  def test_primary_key_option
+    assert_equal "Name\nGabriel\nIcaro\n", @people.to_csv
+    assert_equal "Name\nGabriel\nIcaro\n", @people.to_csv(:primary_key => false)
+    assert_equal "Name\nGabriel\nIcaro\n", @people.to_csv(:primary_key => nil)
+    assert_equal "Cod;Name\n2;Gabriel\n1;Icaro\n", @people.to_csv(:primary_key => true)
+    assert_equal "Number of discs\n2\n1\n", @movies.to_csv(:primary_key => true, :only => [:number_of_discs])
+    assert_equal "Number of discs\n2\n1\n", @movies.to_csv(:only => [:number_of_discs, :id])
+    assert_equal "Dvd release date;Number of discs;Studio;Subtitles;Title\nMon Dec 08 22:00:00 -0200 2008;2;Warner Home Video;English, French, Spanish;The Dark Knight\nMon Oct 22 22:00:00 -0200 2007;1;Warner Home Video;English, Spanish, French;2001 - A Space Odyssey\n", @movies.to_csv(:primary_key => true, :except => :id)
+    assert_equal "Name\nGabriel\nIcaro\n", @people.to_csv(:methods => :cod)
+  end
+
+  def test_block_passed
+    csv = @movies.to_csv do |csv, movie|
+      csv.title = movie.title.upcase
+      csv.number_of_discs = "%02d" % movie.number_of_discs
+    end
+    assert_equal "Dvd release date;Number of discs;Studio;Subtitles;Title\nMon Dec 08 22:00:00 -0200 2008;02;Warner Home Video;English, French, Spanish;THE DARK KNIGHT\nMon Oct 22 22:00:00 -0200 2007;01;Warner Home Video;English, Spanish, French;2001 - A SPACE ODYSSEY\n", csv
+  end
+
+  def test_default_settings
+    ToCSV.byte_order_marker = true
+    ToCSV.locale = 'pt-BR'
+    ToCSV.primary_key = true
+    ToCSV.timestamps = true
+    ToCSV.csv_options = { :col_sep => ',' }
+    assert_equal "\xEF\xBB\xBFCreated at,Data de Lançamento do DVD,Id,Número de Discos,Studio,Legendas,Título,Updated at\nSat Dec 12 00:00:00 -0200 2009,Mon Dec 08 22:00:00 -0200 2008,1,2,Warner Home Video,\"English, French, Spanish\",The Dark Knight,Sat Dec 12 00:00:00 -0200 2009\n", Array(@movies.first).to_csv
+  end
+
+  private
+
+    def store_translations(*locales)
+      locale_path = File.join(File.dirname(__FILE__), 'locales')
+      locales.each do |locale|
+        I18n.backend.store_translations locale, YAML.load_file(File.join(locale_path, "#{ locale }.yml"))
+      end
+    end
+end
+

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: to-csv
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- "\xC3\x8Dcaro Leopoldino da Motta"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-23 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fastercsv
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.5
+    version: 
+description: Convert arrays to CSV (array of hashes, matrixes, ActiveRecord objects etc).
+email: icaro.ldm@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG.rdoc
+- README.rdoc
+files: 
+- init.rb
+- MIT-LICENSE
+- Rakefile
+- lib/to_csv/csv_converter.rb
+- lib/to_csv.rb
+- test/database.yml
+- test/fixtures/movie.rb
+- test/fixtures/movies.yml
+- test/fixtures/people.yml
+- test/fixtures/person.rb
+- test/fixtures/schema.rb
+- test/lib/activerecord_test_case.rb
+- test/lib/activerecord_test_connector.rb
+- test/lib/load_fixtures.rb
+- test/locales/en-US.yml
+- test/locales/pt-BR.yml
+- test/tasks.rake
+- test/to_csv_test.rb
+- CHANGELOG.rdoc
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/ilmotta/to-csv
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Convert arrays to CSV (array of hashes, matrixes, ActiveRecord objects etc).
+test_files: []
+